Skip to content

Cedente Api (v1.0.0)

API Cedente

A API Cedente foi desenvolvida para oferecer um controle abrangente e eficiente sobre o gerenciamento de cedentes no sistema. Com ela, é possível realizar operações completas de CRUD (Create, Read, Update, Delete) para cedentes, incluindo funcionalidades avançadas de filtragem por diversos critérios como nome, apelido, status, visibilidade, grupos empresariais e políticas de limites. Esta API também permite a consulta de cedentes vinculados a agentes específicos e a recuperação de cedentes ativos, garantindo flexibilidade e precisão no acesso aos dados.

Simplificando o gerenciamento de cedentes 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_cedentes_extend.json
api_cedentes_extend.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/api_cedentes_extend/
http://rgbsys.dyndns.info/ger2025-cedente-api-desenvolvimento/

Agentes

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

  • Cadastrar Agente:
    • Cria um novo agente no sistema com todas as informações necessárias.
  • Alterar Agente:
    • Atualiza os dados de um agente existente pelo seu identificador.
  • Listar Agentes:
    • Recupera todos os agentes com opções de filtragem por nome, nível, status, e outras propriedades, além de paginação.
  • Listar Agentes de uma Política de Comissão:
    • Recupera todos os agentes vinculados a uma política de comissão específica.
  • Listar Agentes Ativos:
    • Recupera somente os agentes que estão ativos no sistema.
  • Consultar Agente por ID:
    • Busca um agente específico pelo seu identificador único.
  • Excluir Agente:
    • Remove um agente do sistema pelo seu identificador.
  • Alterar Política de Comissão de Agente:
    • Atualiza a política de comissão vinculada a um agente específico.
Operations

Cedentes

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

  • Cadastrar Cedente:
    • Cria um novo cedente no sistema.
  • Alterar Cedente:
    • Atualiza os dados de um cedente existente pelo seu identificador.
  • Listar Cedentes:
    • Recupera todos os cedentes com opções de filtragem por nome, apelido, status, visibilidade, grupo empresarial, política de limites e paginação.
  • Listar Cedentes do Agente:
    • Recupera todos os cedentes vinculados a um agente específico.
  • Listar Cedentes Ativos:
    • Recupera somente os cedentes que estão ativos no sistema.
  • Consultar Cedente por ID:
    • Busca um cedente específico pelo seu identificador único.
  • Excluir Cedente:
    • Remove um cedente do sistema pelo seu identificador.
Operations

Politicas Checagens

Operations

Politicas Limites

Operations

Politicas Taxas

Operations

Listar as políticas de taxa do cedente

Request

Retorna uma lista paginada de políticas de taxa do cedente

Path
idstringrequired

Id do cedente associado a política de taxa

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/cedentes/{id}/politicas/taxas'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id da política de taxa

nomestring or nullrequired

Nome da política de taxa

taxanumber(double)required

Valor da taxa da política de taxa

floatnumber(double)required

Valor do float da política de taxa

adValoremnumber(double)required

Valor do ad valorem da política de taxa

revisaostring or null(date-time)required

Data da revisão da política de taxa

ativobooleanrequired

Indica se a política de taxa está ativo ou não

]
Response
application/json
[
  {
    "id": "string",
    "nome": "string",
    "taxa": 0.1,
    "float": 0.1,
    "adValorem": 0.1,
    "revisao": "2019-08-24T14:15:22Z",
    "ativo": true
  }
]