NFS-e: Criar conexão usando certificado A1.
Inicia a conexão com o servidor da prefeitura utilizando um certificado A1 (arquivo).
Parâmetros
- Razão Social: (Letras);
- CNPJ: (Letras);
- Inscrição Municipal: (Letras);
- Cód. Municipio: (Inteiro);
- Ambiente de produção: (Lógico);
- keyStoreFileName: Caminho absoluto do arquivo de configuração;
- keyStorePassword: Senha de acesso ao certificado;
- trustStoreFileName;
- trustStorePassword.
Retorno
Conexão (Variante).
NFS-e: Obter XML do Lote de RPS
Retorna o XML do lote com ou sem a assinatura digital.
Parâmetros
- LoteRPS: Lote de RPS (Variant);
- Assinado: (Lógico).
Retorno
XML do lote (Letras).
NFS-e: Criar conexão usando certificado do Windows
Inicia a conexão com o servidor da prefeitura utilizando um certificado A1 ou A3 (cartão, token) instalado no Windows através da MsCapi.
Parâmetros
- Razão Social: (Letras);
- CNPJ: (Letras);
- Inscrição Municipal: (Letras);
- Cód. Municipio: (Inteiro);
- Ambiente de produção: (Lógico);
- trustStoreFileName;
- trustStorePassword.
Retorno
Conexão (Variante)
NFS-e: RPS definir endereço do Tomador
Permite informar os dados do tomador de serviço.
Parâmetros
- RPS (Variante);
- Tipo de Logradouro: Rua, Avenida, Travessa, ... (Letras);
- Logradouro (Letras);
- Numero (Letras);
- Complemento: (Letras);
- Bairro: (Letras);
- CEP: (Letras);
- Código do Município: Código na na tabela do IBGE (Inteiro);
- UF: Sigla do estado (Letras);
- País: Código do Pais (ver tabela usada pela prefeitura) (Letras);
- e-mail: (Letras);
- Telefone: (Letras).
Retorno
NENHUM
NFS-e: Criar conexão sem certificado digital
Inicia a conexão com o servidor da prefeitura utilizando Login e senha.
Parâmetros
- Razão Social: (Letras)
- CNPJ: (Letras)
- Inscrição Municipal: (Letras)
- Cód. Municipio: (Inteiro)
- Ambiente de produção: (Lógico)
- Tipo de autenticação: (Letras) Constante "WSSE".
- Login/Usuário: (Letras) Nome do usuário;
- Senha: (Letras) Senha de acesso ao certificado
- trustStoreFileName:
- trustStorePassword.
Retorno
Conexão (Variante)
NFS-e: Cancelar NFS-e
Cancela uma NFS-e previamente emitida.
Parâmetros
- Conector: (Variante);
- Numero da NFS-e (Inteiro);
- Protocolo/Código da NFS-e: (Letras).
Retorno
XML com a resposta do servidor. (Letras)
NFS-e: RPS definir dados básicos
Define as informações básicas do RPS, data de emissão, tipo de tributação, situação, ...
Parâmetros
- RPS: (Variante);
- Data de emissão (Data);
- Natureza da Operação (Inteiro);
- Regime especial de tributação (Inteiro) - Código de identificação do regime especial de tributação.
- Os seguintes valores são aceitos no padrão ABRASF:
1 - Microempresa municipal;
2 - Estimativa;
3 - Sociedade de profissionais;
4 - Cooperativa;
5 - Microempresário Individual (MEI);
6 - Microempresário e Empresa de Pequeno Porte (ME EPP).
Optante pelo Simples Nacional: Lógico (Verdadeiro/Falso);
Incentivador Cultural: Lógico (Verdadeiro/Falso);
Status: 1 - Normal ou 2 - Cancelado.
Retorno
NENHUM
NFS-e: RPS definir valores totais
Define os totais do serviço e impostos que fazem parte do RPS.
Parâmetros
- RPS: (Variante);
- ValorServicos: (Fracionado);
- ValorDeducoes: (Fracionado);
- Valor do PIS: (Fracionado);
- Valor do COFINS: (Fracionado);
- Valor do INSS: (Fracionado);
- Valor do IR (Numérico);
- Valor da CSLL (Fracionado);
- ISS retido: Indica se o ISS foi retido (Lógico);
- Valor do ISS: (Fracionado);
- Valor ISS Retido: (Fracionado);
- Outras retenções: (Fracionado);
- Base cálculo (Fracionado);
- Aliquota (Fracionado), aliquota em percentual aplicado ao serviço. Ex: Para 5 % informe 5,0; para 0,6 % informe 0,6; Para 2,4 % informe 2,4.
- ValorLiquidoNfse (Fracionado);
- Desconto incondicionado (Fracionado);
- Desconto condicionado (Fracionado).
Retorno
NENHUM
NFS-e: RPS definir dados do Tomador
Permite informar os dados do tomador de serviço.
Parâmetros
- RPS (Variante);
- CPF/CNPJ: (Letras);
- Razão Social: (Letras);
- Tipo de Logradouro: Rua, Avenida, Travessa, ... (Letras);
- Logradouro (Letras);
- Numero (Letras);
- Complemento: (Letras);
- Bairro: (Letras);
- Código do Município: Códna na tabela do IBGE (Inteiro);
- UF: Sigla do estado (Letras);
- CEP: (Letras);
- e-mail: (Letras);
- Telefone: (Letras).
Retorno
NENHUM
NFS-e: Novo RPS
Cria um novo RPS dentro do lote específicado.
Parâmetros
- LoteRPS: Identificador do lote (retornado pela função);
- Número;
- Série;
- Tipo:
1 - RPS
2 - Nota mista
3 - Cupom
Retorno
RPS (Variante) que identifica o item dentro do lote.
NFS-e: Enviar Lote de RPS
Transmite um RPS para o servidor da prefeitura.
Parâmetros
- Lote RPS.
Retorno
XML com a resposta do servidor (Letras).
NFS-e: Criar Lote
Cria um lote de RPS a ser enviado à prefeitura.
Parâmetros
- Número do Lote: Número sequencial do Lote (Inteiro)
Retorno
Lote (Variante) utilizada na função de criar RPS e enviar lote.
NFS-e: Processar resposta do servidor
Lê o XML de resposta da prefeitura e retorna em um formato padrão para permitir o processamento simples através do fluxo.
Parâmetros
- Número do Lote: Número sequencial do Lote (Inteiro).
Retorno
Lote (Variante) utilizada na função de criar RPS e enviar lote.
NFS-e: Consultar situação do Lote de RPS
Obtém a situação do lote no servidor da prefeitura.
Parâmetros
- Conector: (Variante);
- Protocolo: Protocolo de entrega do lote, ou número do lote (São Paulo-SP) (Letras).
Retorno
XML com a resposta do servidor. (Letras)
NFS-e: Consultar situação do Lote de RPS
Obtém a situação do lote no servidor da prefeitura.
Parâmetros
- Conector: (Variante);
- Protocolo: Protocolo de entrega do lote, ou número do lote (São Paulo-SP) (Letras).
Retorno
XML com a resposta do servidor. (Letras)
NFS-e: RPS Dados do Serviço
Define as informações do serviço, código, discriminação, etc.
Parâmetros
- RPS (Variante);
- Item da lista de serviço: (Letras) Código do serviço na tabela da prefeitura.
- Código CNAE do serviço (Letras) - Opcional;
- Código de tributação do município (Letras);
- Discriminação - (Letras) Descrição dos serviços prestados.
- Código do município (na tabela do IBGE) onde o serviço foi prestado. (Inteiro)
Retorno
NENHUM
NFS-e: Consultar RPS
Obtém informações sobre um RPS.
Parâmetros
- Conector: (Variante);
- Número: (Inteiro);
- Série: (Letras);
- Tipo: (Inteiro).
Retorno
(Letras)
NFS-e: RPS adicionar Item
Adicionar os detalhes dos itens do RPS.
Parâmetros
- RPS: (Variante);
- Discriminação do serviço: (Letras);
- Quantidade: (Fracionado);
- Valor unitário: (Fracionado);
- Valor total: (Fracionado).
Retorno
NENHUM
NFS-e: RPS definir RPS substituído
Informa o número do RPS que está sendo substituído.
Parâmetros
- RPS: (Variante);
- Número: Número do RPS referenciado (Inteiro).
- Serie: Séri do RPS (Letras);
- Tipo: (Inteiro);
Retorno
NENHUM
NFS-e: Obter informações do Certificado
Extra informações do certificado digital.
Parâmetros
- Conector: (Variante).
Retorno
(Variant) Mapa com as informações retornadas:
- RAZAO_SOCIAL - Razao Social / Nome do dono od certificado;
- CPF_CNPJ - Documento do dono do certificado;
- DATA_EXPIRACAO - Data de expiração do certificado;
- DATA_INICIAL - Data inicial de valide do certificado;
- ESTADO - Estado do dono do certificado;
- CIDADE - Cidade do dono do certificado;
- PAIS - Pais do dono do certificado;
- ORGANIZACAO - Deve ser "ICP-Brazil";
- NOME - Nome completo contido no certificado, normalmente o o nome seguido de ":" e o CPF/CNPJ;
- ASSINATURA_DIGITAL - Indica se o certificado pode ser usado para assinar documentos (, necessário para assinatura das NFs);
- AUTENTICACAO_CLIENTE - Indica se o certificado pode ser usado para estabelecer uma conexão SSL (, necessário para envio dos arquivos).
NFS-e: RPS definir aliquotas dos Impostos
Define as aliquotas utilizadas para cálculo dos impostos.
Parâmetros
- RPS: (Variante);
- Aliquota PIS: (Fracionado);
- Aliquota COFINS: (Fracionado);
- Aliquota INSS: (Fracionado);
- Aliquota IR: (Fracionado);
- Aliquota CSLL (Numérico).
Retorno
NENHUM
NFS-e: Consultar Lote de RPS
Obtém a informações do lote após processado pelo servidor da prefeitura.
Parâmetros
- Conector: (Variante);
- Protocolo: Protocolo de entrega do lote, ou número do lote (São Paulo-SP) (Letras).
Retorno
XML com a resposta do servidor. (Letras)
NFS-e: Criar conexão usando certificado A3
Inicia a conexão com oservidor da prefeitura utilizando um certificado A3 (cartão, token).
Parâmetros
- Razão Social: (Letras);
- CNPJ: (Letras);
- Inscrição Municipal: (Letras);
- Cód. Municipio: (Inteiro);
- Ambiente de produção: (Lógico);
- configFile: Caminho absoluto do arquivo de configuração.
- pin: Senha de acesso ao certificado.
- trustStoreFileName;
- trustStorePassword.
Retorno
Conexão (Variante)
NFS-e: Cancelar NFS-e (com motivo)
Cancela uma NFS-e previamente emitida.
Parâmetros
- Conector: (Variante);
- Numero da NFS-e (Letras);
- Protocolo/Código da NFS-e: (Letras);
- Motivo do cancelamento: (Letras).
Retorno
XML com a resposta do servidor. (Letras)
NFS-e: RPS definir identificação do Tomador
Permite informar os dados de identificação do tomador de serviço.
Parâmetros
- RPS (Variante)
- Tipo do tomador (Inteiro) -Código que identifica o tipo do tomador, podendo ser:
- 0 = Automático / 1 = Pessoa física / 2 = Pessoa Jurídica;
- 10 - Estrangeiro não especifico / 11 = Estrangeiro pessoa física / 12 = Estrangeiro pessoa jurídica;
- 99 = Não informado ou cliente avulso.
- CPF/CNPJ/Doc: (Letras) Documento de identificação do tomador;
- Razão Social: (Letras);
- Nome fantasia: (Letras);
- Insc. Municipal (Letras) - Inscrição municipal;
- Insc. Estadual (Letras) - Inscrição estadual.
Retorno