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

Cadastrar um novo feriado

Request

Cadastra um novo feriado na base de dados.

Body
required
datastring(date-time)required

Data do feriado

nomestring or nullrequired

Nome do feriado

recorrentebooleanrequired

Indica se o feriado é recorrente ou não

vigenciaobject or null(VigenciaData)required

Período de vigência do feriado

vigencia.​inicialstring(date-time)required

Data de início da vigência

vigencia.​finalstring or null(date-time)required

Data de fim da vigência

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/feriados \
  -H 'Content-Type: application/json' \
  -d '{
    "data": "2019-08-24T14:15:22Z",
    "nome": "string",
    "recorrente": true,
    "vigencia": {
      "inicial": "2019-08-24T14:15:22Z",
      "final": "2019-08-24T14:15:22Z"
    }
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

id

Response
application/json
{
  "id": "string"
}

Listar feriados

Request

Listar feriados da base de dados.

Query
dataIniciostring(date-time)

Data inicial

dataFimstring(date-time)

Data final

nomestring

Nome ou parte do nome do feriado

recorrenteboolean

Indica se o feriado é recorrente ou não

paginainteger(int32)

Indica o númer da página solicitada

Default null
registrosinteger(int32)

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

Default null
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/feriados?dataInicio=2019-08-24T14%3A15%3A22Z&dataFim=2019-08-24T14%3A15%3A22Z&nome=string&recorrente=true'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Identificador único do feriado

datastring(date-time)required

Data do feriado

nomestring or nullrequired

Nome do feriado

recorrentebooleanrequired

Indica se o feriado é recorrente

vigenciaobject or null(VigenciaResponse)required

Vigência do feriado

vigencia.​inicialstring(date-time)required

Data inicial da vigência do feriado

vigencia.​finalstring or null(date-time)required

Data final da vigência do feriado

]
Response
application/json
[
  {
    "id": "string",
    "data": "2019-08-24T14:15:22Z",
    "nome": "string",
    "recorrente": true,
    "vigencia": { … }
  }
]

Recuperar feriado por id.

Request

Recuperar feriado por id.

Path
idstringrequired

Identificador único do feriado

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

Responses

OK

Bodyapplication/json
idstring or nullrequired

Identificador único do feriado

datastring(date-time)required

Data do feriado

nomestring or nullrequired

Nome do feriado

recorrentebooleanrequired

Indica se o feriado é recorrente

vigenciaobject or null(VigenciaResponse)required

Vigência do feriado

vigencia.​inicialstring(date-time)required

Data inicial da vigência do feriado

vigencia.​finalstring or null(date-time)required

Data final da vigência do feriado

Response
application/json
{
  "id": "string",
  "data": "2019-08-24T14:15:22Z",
  "nome": "string",
  "recorrente": true,
  "vigencia": {
    "inicial": "2019-08-24T14:15:22Z",
    "final": "2019-08-24T14:15:22Z"
  }
}

Alterar um feriado

Request

Alterar feriado da base de dados

Path
idstringrequired

Identificador único do feriado

Body
required
idstring or nullrequired

Identificador do feriado

datastring(date-time)required

Data do feriado

nomestring or nullrequired

Nome do feriado

recorrentebooleanrequired

Indica se o feriado é recorrente ou não

vigenciaobject or null(VigenciaDataAlterar)required

Período de vigência do feriado

vigencia.​inicialstring(date-time)required

Data de início da vigência

vigencia.​finalstring or null(date-time)required

Data de fim da vigência

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/apis/administracoes/v1/api/v1/administracao/feriados/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "data": "2019-08-24T14:15:22Z",
    "nome": "string",
    "recorrente": true,
    "vigencia": {
      "inicial": "2019-08-24T14:15:22Z",
      "final": "2019-08-24T14:15:22Z"
    }
  }'

Responses

OK

Response
No content

Integracoes

Operations

Municipios

Operations

PoliticasFiscais

Operations