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

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

Cadastrar imagem que representa a integração

Request

Imagem cadastrada com sucesso

Path
idstringrequired

Id da integração

Bodymultipart/form-datarequired
imagemstring(binary)(IFormFile)
curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/integracoes/{id}/imagem' \
  -H 'Content-Type: multipart/form-data' \
  -F imagem=string

Responses

OK

Bodyapplication/json
idinteger(int64)required
Response
application/json
{
  "id": 0
}

Alterar imagem que representa a integração

Request

Imagem alterada com sucesso

Path
idstringrequired

Id da integração

imagemIdinteger(int64)required

Id da imagem

Bodymultipart/form-datarequired
imagemstring(binary)(IFormFile)
curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/integracoes/{id}/imagem/{imagemId}' \
  -H 'Content-Type: multipart/form-data' \
  -F imagem=string

Responses

OK

Bodyapplication/json
idinteger(int64)required
Response
application/json
{
  "id": 0
}

Cadastrar integração e configuração

Request

Cadastrado com sucesso

Body
required
nomestring or nullrequired

Nome da integração

descricaostring or nullrequired

Descrição da integração

ativobooleanrequired

Indica se a integração está ativo ou não

instrucoesAdicionaisstring or nullrequired

Texto indicando os passos que devem ser feitos para o funcionamento da integração

identificadorstring or nullrequired

Identificador para tratamento especial

configuracoesArray of objects or null(IntegracaoConfiguracaoCadastrar)required

Nome da integração

configuracoes[].​nomestring or nullrequired

Nome da configuração

configuracoes[].​descricaostring or nullrequired

Descrição da configuração

configuracoes[].​tipointeger(TipoDadoConfiguracaoEnum)required

Tipo do valor da configuração

configuracoes[].​obrigatoriobooleanrequired

Indica se a configuração é obrigatória ou não

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/integracoes \
  -H 'Content-Type: application/json' \
  -d '{
    "nome": "string",
    "descricao": "string",
    "ativo": true,
    "instrucoesAdicionais": "string",
    "identificador": "string",
    "configuracoes": [
      {
        "nome": "string",
        "descricao": "string",
        "tipo": 0,
        "obrigatorio": true
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired
Response
application/json
{
  "id": "string"
}

Listar todas as integrações do sistema

Request

Lista de integrações

Query
nomestring

Nome ou parte do nome da integraçã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/integracoes?registros=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id da integração

nomestring or nullrequired

Nome da integração

descricaostring or nullrequired

Descrição da integração

ativobooleanrequired

Indica se a integração está ativa ou não

]
Response
application/json
[
  {
    "id": "string",
    "nome": "string",
    "descricao": "string",
    "ativo": true
  }
]

Alterar integração e/ou configuração

Request

Alterado com sucesso

Path
idstringrequired

Id da integração

Body
required
idstring or nullrequired

Id da integração

nomestring or nullrequired

Nome da integração

descricaostring or nullrequired

Descrição da integração

ativobooleanrequired

Indica se a integração está ativo ou não

instrucoesAdicionaisstring or nullrequired

Texto indicando os passos que devem ser feitos para o funcionamento da integração

identificadorstring or nullrequired

Identificador para tratamento especial

configuracoesArray of objects or null(IntegracaoConfiguracaoAlterar)required

Nome da integração

configuracoes[].​idstring or nullrequired

Id da configuração

configuracoes[].​nomestring or nullrequired

Nome da configuração

configuracoes[].​descricaostring or nullrequired

Descrição da configuração

configuracoes[].​tipointeger(TipoDadoConfiguracaoEnum)required

Tipo do valor da configuração

configuracoes[].​obrigatoriobooleanrequired

Indica se a configuração é obrigatória ou não

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/integracoes/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nome": "string",
    "descricao": "string",
    "ativo": true,
    "instrucoesAdicionais": "string",
    "identificador": "string",
    "configuracoes": [
      {
        "id": "string",
        "nome": "string",
        "descricao": "string",
        "tipo": 0,
        "obrigatorio": true
      }
    ]
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

Listar por Id a integração do sistema

Request

Recuperada a integração

Path
idstringrequired

Id da integração

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

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id da integração

nomestring or nullrequired

Nome da integração

descricaostring or nullrequired

Descrição da integração

ativobooleanrequired

Indica se a integração está ativa ou não

instrucoesAdicionaisstring or nullrequired

Texto indicando os passos que devem ser feitos para o funcionamento da integração

identificadorstring or nullrequired

Identificador para tratamento especial

configuracoesArray of objects or null(IntegracaoConfiguracaoResponse)required

Dados da configuração

configuracoes[].​idstring or nullrequired

Id único da entidade GeralIntegracaoConfiguracao

configuracoes[].​nomestring or nullrequired

Nome da configuração

configuracoes[].​descricaostring or nullrequired

Descrição da configuração

configuracoes[].​tipointeger(TipoDadoConfiguracaoEnum)required

Tipo do valor da configuração

configuracoes[].​obrigatoriobooleanrequired

Indica se a configuração é obrigatória ou não

imagemstring or null

Id da imagem que representa a integração

Default null
Response
application/json
{
  "id": "string",
  "nome": "string",
  "descricao": "string",
  "ativo": true,
  "instrucoesAdicionais": "string",
  "identificador": "string",
  "configuracoes": [
    { … }
  ],
  "imagem": null
}

Municipios

Operations

PoliticasFiscais

Operations