Entidade CIDADES

CIDADE.CIDADES

Descrição

Cadastro de cidades utilizadas pelo sistema.

Atributos

Atributo

Domínio

Regras

Descrição

ID(18)

Rqd PK

Id:
Chave de identificação interna

CIDADE

UPPER(100)

Rqd UK

Cidade:
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.

Exemplos:

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

REGIAO_ID

ID(18)

Rqd UK FK AK

Região:
Região em que a cidade está dentro do país (estado, província, etc.)

Referência para REGIOES

NOME_COMPLETO

UPPER(80)

Rqd UK

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

Exemplos:

SÃO LEOPOLDO
SÃO PAULO
ALVORADA
PARIS

CODIGO_MUNICIPIO

INTEGER

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.

BRASAO

ATTACHED_FILE(250)

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

INTEGRADOR_ID

ID(18)

Integrador:
Referência ao modelo de integração para emissão de NFSe.

Referência para INTEGRADOR_CIDADES_NFSE

OBSERVACOES_CONTATO

TEXT_LONG

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.

OBSERVACOES_RPS

TEXT_LONG

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.

RAZAO_SOCIAL_MUNICIPIO

TEXT

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

Exemplos:

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

PERMITE_IMPRIMIR_RPS

FLAG(1)

Rqd

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

Valor padrão = N

PERMITE_IMPRIMIR_NFSE

FLAG(1)

Rqd

Permite impressão da NFSE:
Define se pode ser emitido a NFSE (Nota Fiscal de Serviços Eletrônica)

Valor padrão = N

OBRIGATORIO_CODIGO_ATIVIDADE

FLAG(1)

Rqd

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

Valor padrão = N

CORPO_MAIL

TEXT_LONG

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.

ENVIAR_ARQUIVOS_ANEXOS

FLAG(1)

Rqd

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.

Valor padrão = N

VALOR_DESCONTO

OPTION(1)

Rqd

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

Valores permitidos:

0 - Base de cálculo considerando o desconto. - O Valor de desconto deve ser utilizado para reduzir o valor da base de calculo do ISSQN.
1 - 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.

Valor padrão = 0

CODIGO_MUNICIPIO_TOM

TEXT

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

Exemplos:

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

DIAS_CANCELAMENTO

INTEGER

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"

URL_AUTENTICIDADE

URL

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

FORMA_CANCELAMENTO_NFSE

OPTION(1)

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.

Valores permitidos:

0 - Sistema próprio - Sistema próprio: o ELIGO pode cancelar a nota.
1 - Sistema da prefeitura - O cancelamento somente pode ser realizado pelo sistema ou site da prefeitura (o usuário pode cancelar)
9 - 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_SUBSTITUICAO_NFSE

OPTION(1)

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.

Valores permitidos:

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

PERMITE_DOCUMENTOS_LOTE

FLAG(1)

Rqd

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

Valor padrão = S

INUTILIZACAO

OPTION(1)

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.

Valores permitidos:

N - 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.
R - 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.

QUANTIDADE_MAXIMA_ITENS

INTEGER

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

ARREDONDAMENTO_TRIBUTO

OPTION(1)

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

Valores permitidos:

0 - 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.
1 - 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.
2 - 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.
4 - 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.
5 - 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.
6 - HALF_EVEN - Arredonda para o "vizinho mais próximo", a menos que ambos os vizinhos sejam equidistantes, nesse caso, arredonda para o vizinho par.

SEQUENCIA_RPS

OPTION(1)

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).

Valores permitidos:

S - 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.
N - 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.

CODIGO_POSTAL

CEP(9)

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".

SERIE_NFSE

TEXT

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"

DATA_EMISSAO_RETROATIVA

OPTION(2)

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.

Valores permitidos:

E - Não permite - A cidade não permite que seja emitido um documento com data de emissão retroativa.
P - Permite - A cidade permite que seja emitido um documento com data de emissão retroativa.
A1 - Atualizar (sempre) - A data de emissão do documento deverá ser alterada para a data atual em todos os casos.
A2 - 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.

Valor padrão = P

DATA_EMISSAO_FUTURA

OPTION(1)

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

Valores permitidos:

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

Valor padrão = P

VINCULADO_NACIONAL

OPTION(1)

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".

Valores permitidos:

N - 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.
V - 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.

USUARIO_INCLUSAO_ID

ID(18)

Usuário inclusão:
Usuário que realizou a inclusão da cidade.

Valor padrão = [USER_ID]
Referência para USUARIOS

DATA_INCLUSAO

DATE_TIME

Data de inclusão:
Data de inclusão do registro da cidade.

Valor padrão = [SYSDATE]

USUARIO_ALTERACAO_ID

ID(18)

Usuário alteração:
Usuário que realizou a última alteração no cadastro da cidade

Valor padrão = [USER_ID]
Referência para USUARIOS

DATA_ALTERACAO

DATE_TIME

Data de alteração:
Data e hora da última alteração

Valor padrão = [SYSDATE]

Regras

Calcular nome de identificação da cidade

(Antes de inserir, Antes de alterar)

Calcula o nome concatenando o nome da cidade com o estado e pais (se diferente de Brasil).

Verificar código municipio

(Antes de inserir, Antes de alterar)

Sempre que CODIGO_MUNICIPIO for alterado e não for nulo, pesquisa se existe algum outro município com o mesmo código.
Caso exista, apresenta um WARNING:

Código IBGE da cidade deve possuir no máximo 5 dígitos!

(Antes de inserir, Antes de alterar)

O código IBGE da cidade deve possuir no máximo 5 dígitos.

Código IBGE para cidades do exterior deve ser 99999!

(Antes de inserir, Antes de alterar)

O código IBGE do município deve ser 99999, obrigatoriamente, quando o código da região (estado) for 99.

Buscar(cidade, estado)

Procedimento que procura por uma cidade, permitindo algumas variações:

Nome da cidade + estado, considerando acentuação informada
Nome da cidade + estado, desconsiderando acentuação informada
Nome da cidade sem estado informado, com ou sem acentuação ou cedilhas.

Ao ser chamado, o objeto fica apontando para a cidade encontrada.
Caso não encontrar uma cidade, gera uma exceção (Registro não encontrado).

Exemplos:

"ARAÇAÍ" , "MG"
"ARACAI" , "MG"
"ARACAI" , "MINAS GERAIS"
"ARACAI - MG" , null
"ARACAI / MINAS GERAIS" , null
"Araçaí / Minas Gerais" , null

Buscar cidade pela localidade(localidade, estado_id)

Busca uma cidade a partir do nome de uma localidade.
Utilizado pelo método buscar(cidade, estado) sempre que a rotina não encontra uma cidade (pelo nome da cidade).