v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Cadastros Básicos

Lista de Cidades

Retorna uma lista de Cidades, com paginação, cadastradas no SankhyaOM.

get/v1/cidades

Query parameters

pageinteger

Número da página, iniciando sempre por ZERO (0).

modifiedSincestring

Example:07/10/2025 10:38

Data e hora da última modificação. Quando esse parâmetro é enviado, o serviço retorna apenas os registros que foram modificados a partir da data e hora informadas. Vale ressaltar que este recurso é condicionada a utilização do Log de Alterações no SankhyaOm no ambiente do cliente. O formato deve ser o seguinte: DD/MM/AAAA HH:MM

Response

Lista de Cidades retornada com sucesso.

codigoCidadeinteger

Código identificador único da cidade no sistema.

nomestring

Nome da cidade.

ufstring

Sigla da Unidade Federativa (UF) da cidade.

codigoRegiaointeger

Código da região da cidade pertence.

nomeRegiaostring

Nome da região da cidade pertence.

nomeCorreiostring

Nome da cidade conforme registro nos correios.

codigoMunicipioFiscalinteger

Código do município de domicílio fiscal relacionado à cidade.

Example response

[
  {
    "codigoCidade": 123,
    "nome": "Uberlândia",
    "uf": "MG",
    "codigoRegiao": 101,
    "nomeRegiao": "Triângulo Mineiro",
    "nomeCorreio": "Uberlândia",
    "codigoMunicipioFiscal": 456
  }
]