Interface WS

Cidades

CIDADE.WS_CIDADES

Descrição

API de consulta de cidades pela data da última alteração.

Campos:

Identificação (única) da cidade formada pelo nome da cidade seguida de seu estado e (caso cidade do exterior) do nome do país.
Na identificação, os acentos e cedilhas são removidos o que impede o cadastramento de uma cidade com e sem acentos no mesmo estado.

Ex:

SAO LEOPOLDO - RS
SAO PAULO - SP
ALVORADA - TO
MIAMI - FL - ESTADOS UNIDOS

Arredondamento do tributo:

Forma de arredondamento efetuada para o tributo ISS na prefeitura. Caso não informado é utilizado o padrão HALF_EVEN.
Exemplos para o valor 5,5:

Número	UP	DOWN	CEILING	FLOOR	HALF_UP	HALF_DOWN	HALF_EVEN
5,5	6	5	6	5	6	5	6
2,5	3	2	3	2	3	2	2
1,6	2	1	2	1	2	2	2
1,1	2	1	2	1	1	1	1
1,0	1	1	1	1	1	1	1
-1,0	-1	-1	-1	-1	-1	-1	-1
-1,1	-2	-1	-1	2	-1	-1	-1
-1,6	-2	-1	-1	-2	-2	-2	-2
-2,5	-3	-2	-2	-3	-3	-2	-2
-5,5	-6	-5	-5	-6	-6	-5	-6

Fonte: https://docs.oracle.com/javase/7/docs/api/java/math/RoundingMode.html

UP - Arredonda fora de zero. Sempre incrementa o dígito antes de uma fração descartada não zero. Esse modo de arredondamento nunca diminui a magnitude do valor calculado.
DOWN - Arredonda para zero. Nunca incrementa o dígito antes de uma fração descartada, ou seja, trunca. Esse modo de arredondamento nunca aumenta a magnitude do valor calculado.
CEILING - Arredonda para infinidade positiva. Se o decimal for positivo, comporta-se equivalente a ROUND_UP; se negativo, comporta-se equivalente a ROUND_DOWN. Esse modo de arredondamento nunca diminui o valor calculado.
HALF_UP - Arredonda para o "vizinho mais próximo", a menos que ambos os vizinhos sejam equidistantes, nesse caso, arredonda para cima. Comporta-se equivalente a ROUND_UP se a fração descartada for maior que, ou igual a, 0,5; caso contrário, comporta-se equivalente a ROUND_DOWN. Esse é o modo de arredondamento que é geralmente ensinado nas escolas.
HALF_DOWN - Arredonda para o "vizinho mais próximo", a menos que ambos os vizinhos sejam equidistantes, nesse caso, arredonda para cima. Comporta-se equivalente a ROUND_UP se a fração descartada for maior que, ou igual a, 0,5; caso contrário, comporta-se equivalente a ROUND_DOWN. Esse é o modo de arredondamento que é geralmente ensinado nas escolas.
HALF_EVEN - Arredonda para o "vizinho mais próximo", a menos que ambos os vizinhos sejam equidistantes, nesse caso, arredonda para o vizinho par.

Brasão:

Brasão da cidade, que será utilizado para impressões das Notas Fiscais de Serviço.

Código IBGE:

Código do município conforme o IBGE (Instituto Brasileiro de Geografia e Estatística). Este código é obrigatório para algumas operações, tais como, emissão de NFe e SPED.

Não devem ser utilizado os dois primeiros dígitos a esquerda do código IBGE, apresentado nas consultas realizadas nos links abaixo indicados.
Ex: Novo Hamburgo/RS, apresenta o código 43-13409. Deve ser ignorado o 43-.

A lista de municípios e seus respectivos códigos pode ser consultada no website do IBGE, consultado por estado (clicando na sigla do estado):
http://www.cidades.ibge.gov.br/xtras/home.php?lang=

Consulte também: https://www.tomweb.receita.fazenda.gov.br/TomWeb/SubMenuMunicipios.jsf

Para cidades do exterior (país diferente de Brasil) deve ser informado o código 99999.

Código Receita Federal (TOM):

Código do município para Receita Federal (codigotom) ou SIAFI.
http://www.receita.fazenda.gov.br/publico/tom/TOM.txt
Consultar também: https://www.tomweb.receita.fazenda.gov.br/TomWeb/SubMenuMunicipios.jsf

Ex:

8847 = SANTA ROSA
8771 = NOVO HAMBURGO
8801 = PORTO ALEGRE

Código postal:

Código de endereçamento postal (CEP no Brasil, ZIP nos EUA, etc.) de um ponto central na cidade (p.ex.: Prefeitura ou bairro Centro).
Informação necessária para utilização de APIs do Google para uso do georeferenciamento e definição da latitude e longitude da "cidade".

Corpo e-mail:

Define o conteúdo da mensagem (corpo do e-mail) a ser utilizado no envio dos documentos fiscais de serviço por e-mail. Será utilizado o corpo de e-mail configurado na preferência NFSE.CORPO_EMAIL caso não seja informado um corpo e e-mail específico no cadastro da cidade.

Data de alteração:

Data e hora da última alteração

Data de emissão futura:

Define se a cidade permite a emissão de documentos com data de emissão futura.

Não permite - A cidade não permite que seja emitido um documento com data de emissão futura.
Permite - A cidade permite que seja emitido um documento com data de emissão futura.
Atualizar - A data de emissão do documento deverá ser alterada para a data atual.

Data de emissão retroativa:

Define se a cidade permite a emissão de documentos com data de emissão retroativa, anteriores a data atual.

Não permite - A cidade não permite que seja emitido um documento com data de emissão retroativa.
Permite - A cidade permite que seja emitido um documento com data de emissão retroativa.
Atualizar (sempre) - A data de emissão do documento deverá ser alterada para a data atual em todos os casos.
Atualizar (troca do mês) - A data de emissão do documento deverá ser alterada para a data atual somente quando ocorrer a data for diferente do mês atual.

Data de inclusão:

Data de inclusão do registro da cidade.

Dias para cancelamento:

Quantidade de dias que a prefeitura permite realizar o cancelamento da NFSe , caso não informado será utilizado o definido na preferencia "NFSE.DIAS_CANCELAMENTO"

Enviar arquivos anexos:

Define o envio de e-mail aos destinatários dos documentos contendo como anexos os arquivos relativos ao documento fiscal de serviço:

Arquivo XML da nota autorizada.
Arquivo PDF da DANFE da NFSe caso o envio do arquivo seja permitido pela prefeitura.

Importante observar que o leiaute da DANFE PDF da NFSE não é necessariamente igual ao leiaute utilizado pela prefeitura, sendo necessário que o destinatário valide eletronicamente a NFSE no site da prefeitura.

Forma de cancelamento da NFSe:

Forma que a prefeitura permite o procedimento para o cancelamento da NFSe.

Nos casos de cancelamento diferente de "0" o cancelamento deve ser registrado posteriormente no ELIGO.

Sistema próprio - Sistema próprio: o ELIGO pode cancelar a nota.
Sistema da prefeitura - O cancelamento somente pode ser realizado pelo sistema ou site da prefeitura (o usuário pode cancelar)
Solicitação para prefeitura - Deve ser feita uma solicitação para que a prefeitura realize o cancelamento da nota. No caso, provavelmente será gerado um protocolo que deverá ser avaliado pela prefeitura e esta defere (cancela) ou indefere o cancelamento da nota.

Forma de substituição da NFSe:

Forma que a prefeitura permite o procedimento para a substituição da NFSe.

Nos casos de substituição diferente de "0" deve ser registrado o cancelamento posteriormente no ELIGO.

Sistema próprio - Sistema próprio: o ELIGO pode substituir a nota.
Sistema da prefeitura - A substituição é permita somente pelo sistema ou site da prefeitura (o usuário pode cancelar no ELIGO)
Não disponível

Inutilização:

Procedimento que deve ser realizado ao inutilizar um documento fiscal com a prefeitura.
Caso não informado será utilizado o padrão "Normal", que permite a inutilização.

Normal - Inutiliza no sistema da prefeitura (se disponível) - Se a prefeitura permitir inutilizar uma faixa de RPS deve ser realizado o procedimento na prefeitura.
Não permite (retornar número para uso) - No caso da prefeitura não permitir a inutilização, e não permitir saltos de numeração de RPS, deve ser alterado a série da RPS e retornado o número da RPS no estabelecimento.

Nome da cidade:

Nome completo da cidade (acentos e cedilhas são mantidos).

Ex:

SÃO LEOPOLDO
SÃO PAULO
ALVORADA
PARIS

Código de atividade obrigatório:

É obrigatório o preenchimento do código de atividade para serviços prestados neste município.

Observações de contato:

Observações que a prefeitura exige que sejam apresentadas na NFSe e/ou RPS. Essas informações devem ser verificadas jundo a assessoria tributária fiscal do município.

Observações para RPS:

Texto contendo a lei para uso da RPS. Esse texto deve ser verificadas jundo a assessoria tributária fiscal do município.

Permite documentos em lote:

Define se é permitido a emissão de documentos fiscais eletrônicos de serviço em lote.

Permite impressão da NFSE:

Define se pode ser emitido a NFSE (Nota Fiscal de Serviços Eletrônica)

Permite impressão da RPS:

Define se pode ser emitido a RPS (Recibo de prestação de Serviço)

Quantidade máxima de itens:

Quantidade máxima de itens para as RPS/NFSE.
Quando não informado é utilizado o padrão 1.

Razão Social do município:

Razão Social do município a ser utilizada na emissão dos documentos fiscais RPS e NFSE

Ex:

Prefeitura Municipal de Novo Hamburgo - RS
Prefeitura Municipal do Rio de Janeiro - RJ

Série para NFSE:

Série a ser utilizada para emissão do documento fiscal com a prefeitura, seu preenchimento é opcional e deve ser utilizado somente quando a prefeitura utiliza nomenclatura diferente para quando a série 0 é utilizada. Por exemplo Caxias do Sul, a série utilizada é "S"

Sequência RPS:

Define se a cidade permite a sequência livre (saltos ou falhas) ou exige que a numeração seja sequencial para numeração dos RPS (Recibos Provisórios de Serviços).

Sequência livre - A cidade permite o salto ou falha na numeração dos RPS, possibilitando a emissão de um ou mais RPS para aguardar a autorização da emissão das NFSEs. Não haverá bloqueio para emissão dos documentos fiscais.
Sequência obrigatória - A cidade não permite o envio de RPS com salto ou falha na numeração. Desta forma somente um RPS poderá permanecer no aguardo da autorização da emissão da NFSE. Será apresentada mensagem de erro e não será permitida a emissão de novo RPS enquanto houver um RPS aguardando autorização do município.

URL Autenticidade:

Endereço do site para verificar a validade do documento fiscal com a prefeitura.

Valor desconto:

Caso informado um valor de desconto em um documento de serviço, a base de cálculo do tributo ISSQN deve ser

Base de cálculo considerando o desconto. - O Valor de desconto deve ser utilizado para reduzir o valor da base de calculo do ISSQN.
Base de cálculo integral, não considerando o valor de desconto - A Base de cálculo será o valor de serviço, não considerando o desconto.

Vinculado Ambiente Nacional:

Define se a cidade já está vinculado ao sistema nacional para emissão de NFSE, caso marcado o percentual de ISS é definido pelo sistema, e não deve ser enviado.
Caso em branco é considerado como "não vinculado".

Não vinculado - Se o município de incidência não pertence/vinculado ao Sistema Nacional NFS-e a alíquota não estará parametrizada e, por isso, deverá ser fornecida pelo emitente.
Vinculado - Se o município de incidência pertence/vinculado ao Sistema Nacional NFS-e a alíquota estará parametrizada e, portanto, será fornecida pelo sistema.

Região:

Nome ou identificação da região.

Ex:

Rio Grande do Sul
Santa Catarina
São Paulo
Bahia

Informações região:

Informações da região

Sub-região:

Nome ou identificação da região.

Ex:

Rio Grande do Sul
Santa Catarina
São Paulo
Bahia

Informações Sub-região:

Informações da sub-região

Tipo de região:

Tipo de região ou divisão geográfica ou político/administrativa. P.ex.: Estado, Província, Microrregião, Mesoregião, Distrito.

País:

Nome do país para ser utilizado nas interfaces do sistema.

Informações país:

Informações do pais

Integrador NFSE:

Nome do integrador de NFSe que é utilizado pelo município.

Informações integrador NFSE:

Informações do integrador NFSE

Operações

Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação [b:Listar].
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Topo

Listar

Apresenta uma lista com os registros que atendem aos filtros informados.
A lista possui diversos recursos práticos e importantes para o usuário:

Clique no link apresentado na primeira coluna para acessar um registro específico. Você também pode usar as teclas (seta para baixo) e (seta para cima) para navegar entre os registros apresentados para acessá-lo.
Normalmente, o cursor fica ativo no link do primeiro registro, ou no registro que estava sendo acessado no caso do usuário voltar para a lista após acessar um registro específico.
É possível reordenar a lista clicando no título da coluna desejada. Clicar no título de uma coluna que já está sendo ordenada, inverte o sentido da ordenação (ascendente/descendente). Clicar no link juntamente com a tecla SHIFT, acrescenta a coluna à ordenação já imposta, permitindo ordenar primeiro por uma coluna e segundo por outra.
Ao clicar no ícone de agrupamento, a lista é refeita apresentando todas as informações totalizáveis dos registros agrupados pela respectiva coluna.
No canto superior direito da tabela com a lista, existe um ícone que, ao ser clicado, abre um pequeno menu que permite o usuário configurar a tabela.
No menu de configuração da tabela, o usuário pode escolher quais colunas devem ser apresentadas e em que posição.
No menu de configuração da tabela, o usuário pode gerar uma pivot da mesma.
Antes da lista, são apresentados os filtros aplicados. Cada filtro possui um pequeno "x" que pode ser utilizado para exclui-lo. Ao fazer isso, a lista é automaticamente atualizada.

Cidade	Arredondamento do tributo	Código Receita Federal (TOM)	Data de emissão futura	Data de emissão retroativa	Enviar arquivos anexos	Forma de cancelamento da NFSe	Forma de substituição da NFSe	Inutilização	Nome da cidade	Código de atividade obrigatório	Permite documentos em lote	Permite impressão da NFSE	Permite impressão da RPS	Razão Social do município	Sequência RPS	Valor desconto	Vinculado Ambiente Nacional	Região	Sub-região
SAO LEOPOLDO - RS	UP	8847 = SANTA ROSA	Não permite	Não permite	Não	Sistema próprio	Sistema próprio	Normal - Inutiliza no sistema da prefeitura (se disponível)	SÃO LEOPOLDO	Não	Não	Não	Não	Prefeitura Municipal de Novo Hamburgo - RS	Sequência livre	Base de cálculo considerando o desconto.	Não vinculado	Rio Grande do Sul	Rio Grande do Sul
SAO PAULO - SP	DOWN	8771 = NOVO HAMBURGO	Permite	Permite	Sim	Sistema da prefeitura	Sistema da prefeitura	Não permite (retornar número para uso)	SÃO PAULO	Sim	Sim	Sim	Sim	Prefeitura Municipal do Rio de Janeiro - RJ	Sequência obrigatória	Base de cálculo integral, não considerando o valor de desconto	Vinculado	Santa Catarina	Santa Catarina
ALVORADA - TO	CEILING	8801 = PORTO ALEGRE	Atualizar	Atualizar (sempre)	Não	Solicitação para prefeitura	Não disponível	Normal - Inutiliza no sistema da prefeitura (se disponível)	ALVORADA	Não	Não	Não	Não	Prefeitura Municipal de Novo Hamburgo - RS	Sequência livre	Base de cálculo considerando o desconto.	Não vinculado	São Paulo	São Paulo
MIAMI - FL - ESTADOS UNIDOS	HALF_UP	8847 = SANTA ROSA	Não permite	Atualizar (troca do mês)	Sim	Sistema próprio	Sistema próprio	Não permite (retornar número para uso)	PARIS	Sim	Sim	Sim	Sim	Prefeitura Municipal do Rio de Janeiro - RJ	Sequência obrigatória	Base de cálculo integral, não considerando o valor de desconto	Vinculado	Bahia	Bahia

Comportamento:

Antes de apresentar cada registro: Preencher detalhes

Topo

Consultar

A consulta de um registro é realizada quando o usuário clica no primeiro link de um dos registros resultantes a operação [b:Listar]. A tela apresenta as informações detalhadas do registro, bem como as ações que o usuário pode disparar a partir dele (alterar, excluir, cancelar, etc.).

Cidade:	SAO LEOPOLDO - RS
Arredondamento do tributo:	UP
Brasão:
Código IBGE:
Código Receita Federal (TOM) :	8847 = SANTA ROSA
Código postal:
Corpo e-mail:
Data de alteração:
Data de emissão futura:	Não permite
Data de emissão retroativa:	Não permite
Data de inclusão:
Dias para cancelamento:
Enviar arquivos anexos:	Não
Forma de cancelamento da NFSe:	Sistema próprio
Forma de substituição da NFSe:	Sistema próprio
Inutilização:	Normal - Inutiliza no sistema da prefeitura (se disponível)
Nome da cidade:	SÃO LEOPOLDO
Código de atividade obrigatório:	Não
Observações de contato:
Observações para RPS:
Permite documentos em lote:	Não
Permite impressão da NFSE:	Não
Permite impressão da RPS:	Não
Quantidade máxima de itens:
Razão Social do município:	Prefeitura Municipal de Novo Hamburgo - RS
Série para NFSE:
Sequência RPS:	Sequência livre
URL Autenticidade:
Valor desconto:	Base de cálculo considerando o desconto.
Vinculado Ambiente Nacional:	Não vinculado
Região:	Rio Grande do Sul
Informações região:
Sub-região:	Rio Grande do Sul
Informações Sub-região:
Tipo de região:
País:
Informações país:
Integrador NFSE:
Informações integrador NFSE:

Comportamento:

Antes de apresentar cada registro: Preencher detalhes

Regras

Preencher detalhes

Preenche informações de detalhe:

Região
Pais

Eventos que disparam esta regra:

Antes de apresentar cada registro formulário "Consultar"
Antes de apresentar cada registro formulário "Listar"

Índice