Skip to content

Administração Api (v1.0.0)

API de Gestão de Bancos

A API de Gestão de Bancos foi desenvolvida para proporcionar controle total sobre as informações dos bancos cadastrados dentro do sistema. Com ela, você pode gerenciar o ciclo de vida dos registros de bancos, desde o cadastro até a alteração e exclusão, além de consultar detalhes específicos.

Simplificando a administração e a conectividade dos dados de bancos com o poder e a flexibilidade de uma API de alta performance!

A seguir, detalhamos as principais funcionalidades oferecidas por cada um dos endpoints.

Download OpenAPI description
v1.json
v1.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/
http://rgbsys.dyndns.info/ger2025-administracao-api-desenvolvimento/

Bancos

Este conjunto de recursos permite a manipulação e consulta de dados de bancos no sistema:

  • Cadastrar Banco:
    • Crie novos registros de bancos na base de dados.
  • Listar Bancos:
    • Obtenha uma lista completa de todos os bancos registrados.
    • Consulte bancos com opções de filtragem por código, nome, paginação e quantidade de registros. É possível listar também apenas bancos ativos.
  • Consultar Banco por ID:
    • Recupere os detalhes de um banco específico utilizando seu identificador único.
  • Alterar Banco:
    • Atualize as informações de um banco existente na base de dados.
  • Excluir Banco:
    • Exclua um registro de banco da base de dados utilizando seu identificador único.
Operations

Cnaes

Estes recursos são dedicados ao gerenciamento das Classificações Nacionais de Atividades Econômicas (CNAEs):

  • Cadastrar CNAE:
    • Adiciona um novo CNAE ao sistema.
  • Alterar CNAE:
    • Modifica as informações de um CNAE existente.
  • Listar CNAEs:
    • Obtém todos os CNAEs com opções de filtragem por descrição e paginação.
  • Consultar CNAE por ID:
    • Busca um CNAE específico pelo seu identificador único.
  • Listar CNAEs Ativos:
    • Recupera somente os CNAEs que estão ativos no sistema.
Operations

Cadastrar o cnae no sistema

Request

Cnae cadastrado com sucesso

Body
required
secaostring or nullrequired

Código da seção do cnae

divisaostring or nullrequired

Código da divisão do cnae

grupostring or nullrequired

Código do grupo do cnae

classestring or nullrequired

Código da classe do cnae

subClassestring or nullrequired

Código da subclasse do cnae

descricaostring or nullrequired

Descrição do cnae

ativobooleanrequired

Indica se o cnae está ativo ou não

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/cnaes \
  -H 'Content-Type: application/json' \
  -d '{
    "secao": "string",
    "divisao": "string",
    "grupo": "string",
    "classe": "string",
    "subClasse": "string",
    "descricao": "string",
    "ativo": true
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id único do cnae

secaostring or nullrequired

Seção do cnae

divisaostring or nullrequired

Divisão do cnae

grupostring or nullrequired

Grupo do cnae

classestring or nullrequired

Classe do cnae

subClassestring or nullrequired

SubClasse do cnae

descricaostring or nullrequired

Descrição do cnae

ativobooleanrequired

Identifica se o cnae está ativo ou não

Response
application/json
{
  "id": "string",
  "secao": "string",
  "divisao": "string",
  "grupo": "string",
  "classe": "string",
  "subClasse": "string",
  "descricao": "string",
  "ativo": true
}

Listar todos os cnaes do sistema

Request

Cnaes listados com sucesso

Query
descricaostring

Cnae ou parte da descrição

Default null
paginainteger(int32)

Indica o número da página solicitada

Default null
registrosinteger(int32)

Indica a quantidade máxima de registros que devem ser retornadas

Default 10
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/cnaes?registros=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id único do cnae

secaostring or nullrequired

Seção do cnae

divisaostring or nullrequired

Divisão do cnae

grupostring or nullrequired

Grupo do cnae

classestring or nullrequired

Classe do cnae

subClassestring or nullrequired

SubClasse do cnae

descricaostring or nullrequired

Descrição do cnae

ativobooleanrequired

Identifica se o cnae está ativo ou não

]
Response
application/json
[
  {
    "id": "string",
    "secao": "string",
    "divisao": "string",
    "grupo": "string",
    "classe": "string",
    "subClasse": "string",
    "descricao": "string",
    "ativo": true
  }
]

Alterar o cnae no sistema

Request

Cnae alterado com sucesso

Path
idstringrequired

Id do cnae

Body
required
idstring or nullrequired

Id do cnae

secaostring or nullrequired

Código da seção do cnae

divisaostring or nullrequired

Código da divisão do cnae

grupostring or nullrequired

Código do grupo do cnae

classestring or nullrequired

Código da classe do cnae

subClassestring or nullrequired

Código da subclasse do cnae

descricaostring or nullrequired

Descrição do cnae

ativobooleanrequired

Indica se o cnae está ativo ou não

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/cnaes/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "secao": "string",
    "divisao": "string",
    "grupo": "string",
    "classe": "string",
    "subClasse": "string",
    "descricao": "string",
    "ativo": true
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

Recuperar cnae por id

Request

Cnae recuperado com sucesso

Path
idstringrequired

Id do cnae

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/cnaes/{id}'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id único do cnae

secaostring or nullrequired

Seção do cnae

divisaostring or nullrequired

Divisão do cnae

grupostring or nullrequired

Grupo do cnae

classestring or nullrequired

Classe do cnae

subClassestring or nullrequired

SubClasse do cnae

descricaostring or nullrequired

Descrição do cnae

ativobooleanrequired

Identifica se o cnae está ativo ou não

Response
application/json
{
  "id": "string",
  "secao": "string",
  "divisao": "string",
  "grupo": "string",
  "classe": "string",
  "subClasse": "string",
  "descricao": "string",
  "ativo": true
}

Listar todos os cnaes ativos do sistema

Request

Cnaes ativos listados com sucesso

Query
descricaostring

Cnae ou parte da descrição

Default null
paginainteger(int32)

Indica o número da página solicitada

Default null
registrosinteger(int32)

Indica a quantidade máxima de registros que devem ser retornadas

Default 10
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/cnaes/ativos?registros=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id único do cnae

secaostring or nullrequired

Seção do cnae

divisaostring or nullrequired

Divisão do cnae

grupostring or nullrequired

Grupo do cnae

classestring or nullrequired

Classe do cnae

subClassestring or nullrequired

SubClasse do cnae

descricaostring or nullrequired

Descrição do cnae

]
Response
application/json
[
  {
    "id": "string",
    "secao": "string",
    "divisao": "string",
    "grupo": "string",
    "classe": "string",
    "subClasse": "string",
    "descricao": "string"
  }
]

Integrações

Estes recursos são dedicados ao gerenciamento de integrações e suas configurações:

  • Cadastrar Integração e Configuração:
    • Cria uma nova integração e suas respectivas configurações.
  • Alterar Integração e/ou Configuração:
    • Modifica uma integração existente e/ou suas configurações.
  • Cadastrar Imagem da Integração:
    • Realiza o upload de uma imagem que representa a integração.
  • Alterar Imagem da Integração:
    • Atualiza a imagem de uma integração existente.
  • Listar Integrações:
    • Recupera todas as integrações com opções de filtragem por nome e paginação.
  • Consultar Integração por ID:
    • Busca uma integração específica pelo seu identificador único.

Políticas Fiscais

Estes recursos são dedicados ao gerenciamento de políticas fiscais:

  • Cadastrar Política Fiscal:
    • Adiciona uma nova política fiscal ao sistema.
  • Alterar Política Fiscal:
    • Atualiza os dados de uma política fiscal existente.
  • Listar Políticas Fiscais:
    • Recupera todas as políticas fiscais com opções de filtragem por nome e paginação.
  • Consultar Política Fiscal por ID:
    • Busca uma política fiscal específica pelo seu identificador único.
  • Listar Políticas Fiscais Ativas:
    • Lista somente as políticas fiscais que estão ativas no sistema.

Feriados

Operations

Integracoes

Operations

Municipios

Operations

PoliticasFiscais

Operations