Skip to content

Gerencial Api (v1.0.0)

API Gerencial

A API Gerencial foi desenvolvida para oferecer um controle abrangente e eficiente sobre diversos dados mestres e configurações essenciais para as operações e funções administrativas do sistema. Com ela, é possível gerenciar entidades como cargos, CNAEs, grupos empresariais, integrações, perfis de usuário, políticas fiscais, ramos de atividade, setores, tipos de empresas, pessoas jurídicas e regimes tributários. Esta API visa simplificar a administração de entidades de negócio centrais, garantindo a consistência e acessibilidade dos dados.

Simplificando a gestão de dados mestres e configurações 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
api_gerenciais_extend.json
api_gerenciais_extend.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/
http://rgbsys.dyndns.info/ger2025-gerencial-api-desenvolvimento/

Cargos

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

  • Cadastrar Cargo:
    • Cria um novo cargo no sistema.
  • Alterar Cargo:
    • Atualiza os dados de um cargo existente pelo seu identificador.
  • Listar Cargos:
    • Recupera todos os cargos com opções de filtragem por nome e paginação.
  • Consultar Cargo por ID:
    • Busca um cargo específico pelo seu identificador único.
  • Listar Cargos Ativos:
    • Recupera somente os cargos que estão ativos no sistema.
Operations

Cadastrar um novo cargo

Request

Cadastra um novo cargo no sistema

Body
required
nomestring or nullrequired

Nome do cargo

descricaostring or nullrequired

Descrição do cargo

usuariosIdsArray of strings or nullrequired

Lista de usuários associados ao cargo

ativobooleanrequired

Indica se o cargo está ativo ou não

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/cargos \
  -H 'Content-Type: application/json' \
  -d '{
    "nome": "string",
    "descricao": "string",
    "usuariosIds": [
      "string"
    ],
    "ativo": true
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do cargo

nomestring or nullrequired

Nome do cargo

descricaostring or nullrequired

Descrição do cargo

ativobooleanrequired

Indica se o cargo está ativo ou não

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

Listar todos os cargos do sistema

Request

Recupera todos os cargos com paginação

Query
nomestring

Nome ou parte do nome do cargo

Default null
ativoboolean

Indica se deve recuperar apenas os cargos ativos

Default null
usuarioIdsArray of strings

Ids dos usuários vinculados ao cargo

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/api_gerenciais_extend/api/v1/gerencial/cargos?registros=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do cargo

nomestring or nullrequired

Nome do cargo

descricaostring or nullrequired

Descrição do cargo

ativobooleanrequired

Indica se o cargo está ativo ou não

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

Alterar dados do cargo

Request

Alteração dos dados do cargo pelo Id

Path
idstringrequired

Id do cargo

Body
required
idstring or nullrequired

Id do cargo

nomestring or nullrequired

Nome do cargo

descricaostring or nullrequired

Descrição do cargo

usuariosIdsArray of strings or nullrequired

Lista de usuários associados ao cargo

ativobooleanrequired

Indica se o cargo está ativo ou não

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/cargos/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nome": "string",
    "descricao": "string",
    "usuariosIds": [
      "string"
    ],
    "ativo": true
  }'

Responses

OK

Response
No content

Recupera o cargo por id

Request

Recupera um cargo específico pelo Id

Path
idstringrequired
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/cargos/{id}'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do cargo

nomestring or nullrequired

Nome do cargo

descricaostring or nullrequired

Descrição do cargo

ativobooleanrequired

Indica se o cargo está ativo ou não

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

Recupera o cargo por id

Request

Recupera um cargo específico pelo Id

Path
idstringrequired

Id do cargo a ser excluido

curl -i -X DELETE \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/cargos/{id}'

Responses

OK

Bodyapplication/json
Response
application/json
null

Listar todos os cargos ativos

Request

Recupera todos os cargos ativos do sistema

Query
nomestring

Nome ou parte do nome do cargo

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/api_gerenciais_extend/api/v1/gerencial/cargos/ativos?registros=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do cargo

nomestring or nullrequired

Nome do cargo

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

Feriados

Este conjunto de recursos permite a administração de feriados:

  • Cadastrar Feriado:
    • Cria um novo feriado na base de dados.
  • Alterar Feriado:
    • Atualiza os dados de um feriado existente pelo seu identificador.
  • Listar Feriados:
    • Lista todos os feriados com opções de filtragem por data, nome, UF, município e paginação.
  • Consultar Feriado por ID:
    • Recupera um feriado específico pelo seu identificador.
  • Listar Feriados Ativos:
    • Lista apenas os feriados ativos com base em uma data de referência e período específico.
Operations

Grupos Empresariais

Este conjunto de recursos permite a administração de grupos empresariais:

  • Cadastrar Grupo Empresarial:
    • Cria um novo grupo empresarial.
  • Alterar Grupo Empresarial:
    • Atualiza os dados de um grupo empresarial existente.
  • Listar Grupos Empresariais:
    • Lista todos os grupos empresariais com opções de filtragem por nome, cedente/sacado e paginação.
  • Consultar Grupo Empresarial por ID:
    • Recupera um grupo empresarial específico pelo seu identificador.
  • Listar Grupos Empresariais Ativos:
    • Lista apenas os grupos empresariais ativos.
  • Associar Cedente/Sacado:
    • Associa um cedente ou sacado a um grupo empresarial pela raiz do CNPJ.
Operations

Perfis

Este conjunto de recursos permite a administração de perfis de usuário:

  • Cadastrar Perfil:
    • Cria um novo perfil no sistema.
  • Alterar Perfil:
    • Atualiza as informações de um perfil existente.
  • Listar Perfis:
    • Obtém todos os perfis com opções de filtragem por nome, nível, tipo de pessoa física e paginação.
  • Consultar Perfil por ID:
    • Busca um perfil específico pelo seu identificador único.
  • Listar Perfis Ativos:
    • Lista somente os perfis que estão ativos no sistema.
  • Excluir Perfil:
    • Remove um perfil do sistema.
Operations

Politicas Checagens

Este conjunto de recursos permite a administração de políticas de checagens:

  • Cadastrar Política de Checagem:
    • Cria uma nova política de checagem no tenant.
  • Alterar Política de Checagem:
    • Atualiza os dados de uma política de checagem existente pelo seu identificador.
  • Listar Políticas de Checagens:
    • Lista todas as políticas de checagens com opções de filtragem por nome, empresas, grupos empresariais, cedentes, sacados, tipos de operação/ativo e paginação.
  • Consultar Política de Checagem por ID:
    • Recupera uma política de checagem específica pelo seu identificador.
  • Listar Políticas de Checagens Ativas:
    • Lista apenas as políticas de checagens ativas do tenant.
  • Listar por Empresa:
    • Lista políticas de checagens associadas a uma empresa específica.
  • Listar por Cedente:
    • Lista políticas de checagens associadas a um cedente específico.
  • Listar por Sacado:
    • Lista políticas de checagens associadas a um sacado específico.
  • Listar por Grupo Empresarial:
    • Lista políticas de checagens associadas a um grupo empresarial específico.
  • Consultar Associações:
    • Recupera os primeiros 10 nomes das empresas, grupos empresariais, cedentes e sacados associados a uma política de checagem.
  • Excluir Política de Checagem:
    • Remove uma política de checagem do sistema.
Operations

Politicas Comissoes Agentes

Este conjunto de recursos permite a administração de políticas de comissões de agentes:

  • Cadastrar Política de Comissão de Agente:
    • Cria uma nova política de comissão com configurações de cálculo, fórmulas personalizadas ou faixas de taxa, e vincula aos agentes especificados.
  • Alterar Política de Comissão de Agente:
    • Atualiza os dados de uma política de comissão existente, incluindo nome, tipo de cálculo, fórmula e agentes vinculados.
  • Consultar Política de Comissão por ID:
    • Recupera os dados detalhados de uma política de comissão específica, incluindo configurações de cálculo e agentes vinculados.
  • Listar Políticas de Comissões de Agentes:
    • Lista todas as políticas de comissão com filtros opcionais por nome, agente, status e paginação.
  • Listar Políticas de Comissões Ativas:
    • Lista apenas as políticas de comissão que estão ativas no tenant, com opção de filtro por nome e paginação.
Operations

Politicas

Este conjunto de recursos permite o gerenciamento de associações de políticas:

  • Associar Política:
    • Associa uma política de limite, taxa, tarifa ou checagem à empresa, grupo empresarial, cedente ou sacado de um tenant.
  • Desassociar Políticas:
    • Remove todas as associações de políticas de limite, taxa e checagem de uma empresa, grupo empresarial, cedente ou sacado específico.
Operations

Politicas Limites

Este conjunto de recursos permite a administração de políticas de limites:

  • Cadastrar Política de Limite:
    • Cria uma nova política de limite no tenant.
  • Alterar Política de Limite:
    • Atualiza os dados de uma política de limite existente pelo seu identificador.
  • Listar Políticas de Limites:
    • Lista todas as políticas de limites com opções de filtragem por nome, empresas, grupos empresariais, cedentes, sacados, tipos de operação/ativo e paginação.
  • Consultar Política de Limite por ID:
    • Recupera uma política de limite específica pelo seu identificador.
  • Listar Políticas de Limites Ativas:
    • Lista apenas as políticas de limites ativas do tenant.
  • Listar por Empresa:
    • Lista políticas de limites associadas a uma empresa específica.
  • Listar por Cedente:
    • Lista políticas de limites associadas a um cedente específico.
  • Listar por Sacado:
    • Lista políticas de limites associadas a um sacado específico.
  • Listar por Grupo Empresarial:
    • Lista políticas de limites associadas a um grupo empresarial específico.
  • Consultar Associações:
    • Recupera os primeiros 10 nomes das empresas, grupos empresariais, cedentes e sacados associados a uma política de limite.
  • Excluir Política de Limite:
    • Remove uma política de limite do sistema.
Operations

Politicas Taxas

Este conjunto de recursos permite a administração de políticas de taxas:

  • Cadastrar Política de Taxa:
    • Cria uma nova política de taxa no tenant.
  • Alterar Política de Taxa:
    • Atualiza os dados de uma política de taxa existente pelo seu identificador.
  • Excluir Política de Taxa:
    • Remove uma política de taxa do sistema.
  • Listar Políticas de Taxas:
    • Lista todas as políticas de taxas com opções de filtragem por nome, empresas, grupos empresariais, cedentes, sacados, tipos de operação/ativo e paginação.
  • Consultar Política de Taxa por ID:
    • Recupera uma política de taxa específica pelo seu identificador.
  • Listar Políticas de Taxas Ativas:
    • Lista apenas as políticas de taxas ativas do tenant.
  • Listar por Empresa:
    • Lista políticas de taxas associadas a uma empresa específica.
  • Listar por Cedente:
    • Lista políticas de taxas associadas a um cedente específico.
  • Listar por Sacado:
    • Lista políticas de taxas associadas a um sacado específico.
  • Listar por Grupo Empresarial:
    • Lista políticas de taxas associadas a um grupo empresarial específico.
  • Consultar Associações:
    • Recupera os primeiros 10 nomes das empresas, grupos empresariais, cedentes e sacados associados a uma política de taxa.
Operations

Ramos

Este conjunto de recursos permite a administração de ramos de atividade:

  • Cadastrar Ramo:
    • Cria um novo ramo em um tenant.
  • Alterar Ramo:
    • Atualiza os dados de um ramo existente em um tenant.
  • Listar Ramos:
    • Obtém todos os ramos de um tenant com opções de filtragem por nome e paginação.
  • Consultar Ramo por ID:
    • Busca um ramo específico de um tenant pelo seu identificador único.
  • Listar Ramos Ativos:
    • Lista somente os ramos ativos de um tenant, ideais para utilização em listas de seleção.
Operations

Setores

Estes recursos são dedicados ao gerenciamento de setores:

  • Cadastrar Setor:
    • Cria um novo setor no sistema.
  • Alterar Setor:
    • Atualiza os dados de um setor existente.
  • Excluir Setor:
    • Remove um setor do sistema.
  • Listar Setores:
    • Obtém todos os setores com opções de filtragem por nome, descrição e paginação.
  • Consultar Setor por ID:
    • Busca um setor específico pelo seu identificador único.
  • Listar Setores Ativos:
    • Lista somente os setores ativos, ideais para utilização em listas de seleção.
Operations

Empresas

Operations

Sacados

Operations