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

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

Cadastrar um novo grupo empresarial

Request

Grupo empresarial cadastrado com sucesso

Body
required
apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

ativobooleanrequired

Indica se o grupo empresarial está ativo ou não

limiteGlobalnumber or null(double)required

Limite global do grupo empresarial

limiteGlobalIlimitadoboolean or nullrequired

Indica se o grupo empresarial tem limite global ou não

limiteSacadonumber or null(double)required

Limite dos sacados dentro do grupo empresarial

limiteCedentenumber or null(double)required

Limite dos cedentes dentro do grupo empresarial

cedenteIdsArray of strings or nullrequired

Array com o ids dos cedentes

sacadoIdsArray of strings or nullrequired

Array com o ids dos sacados

politicasobject or null(PoliticasCadastrar)required

Políticas associadas à empresa

politicas.​limiteArray of strings or nullrequired

Array com os ids das políticas de limite

politicas.​taxaArray of strings or nullrequired

Array com os ids das políticas de taxa

politicas.​checagemArray of strings or nullrequired

Array com os ids das políticas de checagem

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais \
  -H 'Content-Type: application/json' \
  -d '{
    "apelido": "string",
    "nome": "string",
    "ativo": true,
    "limiteGlobal": 0.1,
    "limiteGlobalIlimitado": true,
    "limiteSacado": 0.1,
    "limiteCedente": 0.1,
    "cedenteIds": [
      "string"
    ],
    "sacadoIds": [
      "string"
    ],
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do grupo empresarial

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

Listar os grupos empresariais de um tenant

Request

Recuperado com sucesso

Query
idstring

Id do grupo empresarial

cedenteIdstring

Id do cedente

sacadoIdstring

Id do sacado

nomestring

Nome ou apelido ou parte do nome ou apelido do grupo empresarial

Default null
politicaLimiteIdstring

Id da política de limite

Default null
politicaTaxaIdstring

Id da política de taxa

Default null
politicaChecagemIdstring

Id da política de checagem

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 null
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais?id=string&cedenteId=string&sacadoId=string'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do grupo empresarial

apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

limitesobject or null(LimitesResponse)required

Limites do grupo empresarial

limites.​globalnumber or null(double)required

Limite global

limites.​globalIlimitadoboolean or nullrequired

Indica se o limite global é ilimitado

limites.​sacadonumber or null(double)required

Limite do sacado

limites.​cedentenumber or null(double)required

Limite do cedente

ativobooleanrequired

Indica se o grupo empresarial está ativo

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

Associar um cedente ou sacado à um grupo empresarial pela raiz do Cnpj

Request

Associado com sucesso

Body
required
idstring or nullrequired

Id do grupo empresarial

tipostring or nullrequired

Tipo da associação

associadoIdstring or nullrequired

Id do cedente ou do sacado

associarboolean or null

True para associar, false para desassociar

Default true
curl -i -X PATCH \
  https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "tipo": "string",
    "associadoId": "string",
    "associar": true
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

Alterar um grupo empresarial

Request

Grupo empresarial alterado com sucesso

Path
idstringrequired

Id do grupo empresarial

Body
required
apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

ativobooleanrequired

Indica se o grupo empresarial está ativo ou não

limiteGlobalnumber or null(double)required

Limite global do grupo empresarial

limiteGlobalIlimitadoboolean or nullrequired

Indica se o grupo empresarial tem limite global ou não

limiteSacadonumber or null(double)required

Limite dos sacados dentro do grupo empresarial

limiteCedentenumber or null(double)required

Limite dos cedentes dentro do grupo empresarial

cedenteIdsArray of strings or nullrequired

Array com o ids dos cedentes

sacadoIdsArray of strings or nullrequired

Array com o ids dos sacados

politicasobject or null(PoliticasAlterar)required

Políticas associadas à empresa

politicas.​limiteArray of strings or nullrequired

Array com os ids das políticas de limite

politicas.​taxaArray of strings or nullrequired

Array com os ids das políticas de taxa

politicas.​checagemArray of strings or nullrequired

Array com os ids das políticas de checagem

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "apelido": "string",
    "nome": "string",
    "ativo": true,
    "limiteGlobal": 0.1,
    "limiteGlobalIlimitado": true,
    "limiteSacado": 0.1,
    "limiteCedente": 0.1,
    "cedenteIds": [
      "string"
    ],
    "sacadoIds": [
      "string"
    ],
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

Deletar um grupo empresarial

Request

Grupo empresarial deletado com sucesso

Path
idstringrequired

Id do grupo empresarial

Body
required
object(ExcluirRequest)
curl -i -X DELETE \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais/{id}' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

OK

Bodyapplication/json
Response
application/json
null

Recuperar um grupo empresarial de um tenant

Request

Grupo empresarial recuperado com sucesso

Path
idstringrequired

Id do grupo empresarial

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

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do grupo empresarial

apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

limitesobject or null(LimitesPorIdResponse)required

Limites do grupo empresarial

limites.​globalnumber or null(double)required

Limite global

limites.​globalIlimitadoboolean or nullrequired

Indica se o limite global é ilimitado

limites.​sacadonumber or null(double)required

Limite do sacado

limites.​cedentenumber or null(double)required

Limite do cedente

ativobooleanrequired

Indica se o grupo empresarial está ativo

cedentesArray of objects or null(CedentePorIdResponse)required

Lista de cedentes do grupo empresarial

cedentes[].​idstring or nullrequired

Id do cedente

cedentes[].​apelidostring or nullrequired

Apelido do cedente

cedentes[].​nomestring or nullrequired

Nome do cedente

sacadosArray of objects or null(SacadoPorIdResponse)required

Lista de sacados do grupo empresarial

sacados[].​idstring or nullrequired

Id do sacado

sacados[].​nomestring or nullrequired

Nome do sacado

Response
application/json
{
  "id": "string",
  "apelido": "string",
  "nome": "string",
  "limites": {
    "global": 0.1,
    "globalIlimitado": true,
    "sacado": 0.1,
    "cedente": 0.1
  },
  "ativo": true,
  "cedentes": [
    { … }
  ],
  "sacados": [
    { … }
  ]
}

Recuperar um grupo empresarial por uma raiz de cnpj

Request

Grupo empresarial recuperado com sucesso

Path
raizCnpjstringrequired

Raiz do cnpj de uma pessoa juridica

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais/buscar-por-raiz-cnpj/{raizcnpj}'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do grupo empresarial

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

Listar os grupos empresariais de um tenant

Request

Recuperado com sucesso

Path
idstringrequired

Id da política de limite

Default null
Query
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 null
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/politicas/limites/{id}/grupos-empresariais'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do grupo empresarial

apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

limitesobject or null(LimitesResponse)required

Limites do grupo empresarial

limites.​globalnumber or null(double)required

Limite global

limites.​globalIlimitadoboolean or nullrequired

Indica se o limite global é ilimitado

limites.​sacadonumber or null(double)required

Limite do sacado

limites.​cedentenumber or null(double)required

Limite do cedente

ativobooleanrequired

Indica se o grupo empresarial está ativo

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

Listar os grupos empresariais de um tenant

Request

Recuperado com sucesso

Path
idstringrequired

Id da política de taxa

Default null
Query
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 null
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/politicas/taxas/{id}/grupos-empresariais'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do grupo empresarial

apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

limitesobject or null(LimitesResponse)required

Limites do grupo empresarial

limites.​globalnumber or null(double)required

Limite global

limites.​globalIlimitadoboolean or nullrequired

Indica se o limite global é ilimitado

limites.​sacadonumber or null(double)required

Limite do sacado

limites.​cedentenumber or null(double)required

Limite do cedente

ativobooleanrequired

Indica se o grupo empresarial está ativo

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

Listar os grupos empresariais de um tenant

Request

Recuperado com sucesso

Path
idstringrequired

Id da política de checagens

Default null
Query
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 null
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/politicas/checagens/{id}/grupos-empresariais'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do grupo empresarial

apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

limitesobject or null(LimitesResponse)required

Limites do grupo empresarial

limites.​globalnumber or null(double)required

Limite global

limites.​globalIlimitadoboolean or nullrequired

Indica se o limite global é ilimitado

limites.​sacadonumber or null(double)required

Limite do sacado

limites.​cedentenumber or null(double)required

Limite do cedente

ativobooleanrequired

Indica se o grupo empresarial está ativo

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

Listar os grupos empresariais ativos de um tenant

Request

Recuperado com sucesso

Query
nomestring

Nome ou apelido ou parte do nome ou apelido do grupo empresarial

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 null
curl -i -X GET \
  https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais/ativos

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do grupo empresarial

apelidostring or nullrequired

Apelido do grupo empresarial

nomestring or nullrequired

Nome do grupo empresarial

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

Desassociar um cedente ou sacado à um grupo empresarial

Request

Desassociado com sucesso

Body
required
tipostring or nullrequired

Tipo da associação

associadoIdArray of strings or nullrequired

Id do cedente ou do sacado

curl -i -X PATCH \
  https://apidocs.ger26.com.br/_mock/api_gerenciais_extend/api/v1/gerencial/grupos-empresariais/desassociar \
  -H 'Content-Type: application/json' \
  -d '{
    "tipo": "string",
    "associadoId": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

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