SAsankhya
Cadastros Básicos

Região específica

Retorna um Região específica com base no parâmetro enviado na requisição.

get/v1/regioes/{codigoRegiao}

Request

  • Base URL
    https://api.sankhya.com.br
  • URL
    https://api.sankhya.com.br/v1/regioes/{codigoRegiao}
  • Auth
    API key in header Authorization

Path parameters

codigoRegiaointeger required

Código da Região para retorno

Response

Dados da Região retornados com sucesso.

codigoRegiaointeger

Código da região.

codigoRegiaoPaiinteger

Código da região pai (caso exista hierarquia).

nomestring

Nome da região.

grauinteger

Grau da região, utilizado para hierarquia ou classificação.

analiticaboolean

Indica se a região é analítica.

ativaboolean

Indica se a região está ativa.

Example response

{
  "codigoRegiao": 101,
  "codigoRegiaoPai": 100,
  "nome": "Região Sul",
  "grau": 2,
  "analitica": true,
  "ativa": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.