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

Listar agentes

Request

Lista todos os agentes de um tenant específico

Query
nomestring

Nome ou parte do nome do agente

Default null
nivelstring

Níveis de agente

Default null
statusstring

Status do agente

Default null
possuiEmailboolean

Indica se o usuário possui ou não email

Default null
possuiEnderecoboolean

Indica se o usuário possui ou não endereço

Default null
possuiDadoBancarioboolean

Indica se o usuário possui ou não dados bancários

Default null
politicaComissaoAgenteIdstring

Id da politica de comissão de agentes

Default null
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ascendenteboolean

Indica se a ordenação da coluna nome será ascendete ou nao

Default true
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes?quantidade=10&ascendente=true'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

ID do agente

nomestring or nullrequired

Nome do agente

nivelinteger(NivelAgenteEnum)required

Nivel do agente

statusinteger(StatusAgenteEnum)required

Status do agente

whatsappstring or nullrequired

Whatsapp do agente

possuiEmailbooleanrequired

Indica se o agente possui ou não email

possuiEnderecobooleanrequired

Indica se o agente possui ou não endereço

possuiDadoBancariobooleanrequired

Indica se o agente possui ou não dados bancários

]
Response
application/json
[
  {
    "id": "string",
    "nome": "string",
    "nivel": 0,
    "status": 0,
    "whatsapp": "string",
    "possuiEmail": true,
    "possuiEndereco": true,
    "possuiDadoBancario": true
  }
]

Cadastrar agente

Request

Cadastrar um agente no sistema

Body
required
tipoPessoainteger(TipoPessoaEnum)required

Indica o tipo de pessoa

pessoaFisicaobject or null(UsuarioCadastrarRequest)required

Dados da pessoa fisica + usuário

pessoaFisica.​cpfstring or nullrequired

CPF do Usuário

pessoaFisica.​telefonesArray of objects or null(PessoaFisicaTelefoneCadastrarRequest)required

Array de Telefones do Usuário

pessoaFisica.​telefones[].​numerostring or nullrequired

Número do telefone

pessoaFisica.​telefones[].​tipointeger(TipoTelefoneEnum)required

Tipo de telefone

pessoaFisica.​telefones[].​principalbooleanrequired

Indica se o telefone é o principal ou não

pessoaFisica.​telefones[].​whatsappbooleanrequired

Indica se o telefone recebe whatsapp ou não

pessoaFisica.​telefones[].​smsbooleanrequired

Indica se o telefone recebe sms ou não

pessoaFisica.​telefones[].​pessoaIdstring or null

Id da entidade pessoa

pessoaFisica.​emailsArray of objects or null(PessoaFisicaEmailCadastrarRequest)required

Array de E-mails do Usuário

pessoaFisica.​emails[].​emailstring or nullrequired

Endereço de email

pessoaFisica.​emails[].​principalbooleanrequired

Indica se é o email principal

pessoaFisica.​emails[].​pessoaIdstring or null

Id da entidade pessoa

pessoaFisica.​enderecosArray of objects or null(PessoaFisicaEnderecoCadastrarRequest)required

Array com Endereços do Usuário

pessoaFisica.​enderecos[].​logradourostring or nullrequired

Logradouro do endereço

pessoaFisica.​enderecos[].​numerostring or nullrequired

Número do endereço

pessoaFisica.​enderecos[].​semNumerobooleanrequired

Indica se o endereço possui número ou não

pessoaFisica.​enderecos[].​complementostring or nullrequired

Complemento do endereço

pessoaFisica.​enderecos[].​cepstring or nullrequired

Cep do endereço

pessoaFisica.​enderecos[].​bairrostring or nullrequired

Bairro do endereço

pessoaFisica.​enderecos[].​municipiostring or nullrequired

Município do endereço

pessoaFisica.​enderecos[].​ufstring or nullrequired

Uf do endereço

pessoaFisica.​enderecos[].​principalbooleanrequired

Indica se é o endereço principal

pessoaFisica.​enderecos[].​pessoaIdstring or null

Id da entidade pessoa

pessoaFisica.​acessosArray of objects or null(AcessoUsuarioCadastrarRequest)required

Array com Acessos do Usuário

pessoaFisica.​acessos[].​empresaIdstring or nullrequired

Id da empresa a ser enxergada pela pessoa física

pessoaFisica.​acessos[].​tipoPessoaFisicainteger(TipoPessoaFisicaEnum)required

Tipo de pessoa física

pessoaFisica.​acessos[].​ativobooleanrequired

Indica se o acesso está ativo ou não

pessoaFisica.​setoresArray of objects or null(PessoaSetorRequest)required

Array com os setores do usuário

pessoaFisica.​setores[].​idstring or nullrequired

Id da entidade pessoa setor

pessoaFisica.​nomestring or nullrequired

Nome do Usuário

pessoaFisica.​loginstring or nullrequired

E-mail do Usuário

pessoaFisica.​perfilsIdArray of strings or nullrequired

Id do Perfil para o Tenant Selecionado

pessoaFisica.​identidadeobject or null(UsuarioIdentidadeRequest)required

Número da Identidade do Usuário

pessoaFisica.​identidade.​numerostring or nullrequired

Número da Identidade do Usuário

pessoaFisica.​identidade.​emissaostring or null(date-time)required

Data de Emissão da Identidade do Usuário

pessoaFisica.​nascimentostring or null(date-time)required

Data de Nascimento do Usuário

pessoaFisica.​sitestring or nullrequired

Url do Site do Usuário

pessoaFisica.​tipoAutenticacaoDoisFatoresArray of integers or null(TipoAutenticacaoDoisFatoresEnum)required

Tipo de Autenticação de Dois Fatores

pessoaJuridicaobject or null(PessoaJuridicaCadastrarRequest)required

Dados da pessoa jurídica

pessoaJuridica.​cnpjstring or nullrequired

Cnpj da pessoa jurídica

pessoaJuridica.​dataAberturastring(date-time)required

Data da abertura da pessoa jurídica

pessoaJuridica.​nomeEmpresarialstring or nullrequired

Nome empresarial da pessoa jurídica

pessoaJuridica.​nomeFantasiastring or nullrequired

Nome fantasia da pessoa jurídica

pessoaJuridica.​naturezaJuridicastring or nullrequired

Natureza jurídica da pessoa jurídica

pessoaJuridica.​situacaoCadastralobject or null(SituacaoCadastralRequest)required

Situacao Cadastral da pessoa jurídica

pessoaJuridica.​situacaoCadastral.​descricaostring or nullrequired

Situação cadastral da pessoa jurídica

pessoaJuridica.​situacaoCadastral.​datastring or null(date-time)required

Data da atualização da situação cadastral da pessoa jurídica

pessoaJuridica.​situacaoCadastral.​motivostring or nullrequired

Motivo da situação cadastral da pessoa jurídica

pessoaJuridica.​enderecoReceitaFederalobject or null(EnderecoReceitaFederalRequest)required

Endereço Receita Federal da pessoa jurídica

pessoaJuridica.​enderecoReceitaFederal.​logradourostring or nullrequired

Endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​numerostring or nullrequired

Número do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​semNumerobooleanrequired

Indica se o endereço possui número ou não

pessoaJuridica.​enderecoReceitaFederal.​complementostring or nullrequired

Complemento do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​cepstring or nullrequired

Cep do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​bairrostring or nullrequired

Bairro do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​municipiostring or nullrequired

Município do endereço da pessoa

pessoaJuridica.​enderecoReceitaFederal.​ufstring or nullrequired

Uf do endereço da pessoa

pessoaJuridica.​emailsArray of objects or nullrequired

Array com emails de pessoa jurídica

pessoaJuridica.​telefonesArray of objects or nullrequired

Array com telefones de pessoa jurídica

pessoaJuridica.​enderecosArray of objects or nullrequired

Array com endereços de pessoa jurídica

pessoaJuridica.​inscricaoEstadualstring or nullrequired

Inscrição estadual da pessoa jurídica

pessoaJuridica.​inscricaoMunicipalstring or nullrequired

Inscrição municipal da pessoa jurídica

pessoaJuridica.​matrizbooleanrequired

Indica se a empesa é matriz ou não

pessoaJuridica.​nirestring or nullrequired

Número de identificação do registro de empresas

pessoaJuridica.​sitestring or nullrequired

Url do site da empresa

pessoaJuridica.​tipoRegimeTributarioIdstring or nullrequired

Tipo do regime trubutário

pessoaJuridica.​tipoPessoaJuridicainteger(TipoPessoaJuridicaEnum)required

Tipo de pessoa jurídica

pessoaJuridica.​registroJuntaComercialstring or nullrequired

Registro da junta comercial

dadosBancariosArray of objects or null(PessoaFisicaInformacaoBancariaCadastrarRequest)required

Dados bancários do agente

dadosBancarios[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

dadosBancarios[].​bancoIdinteger(int16)required

Código do banco

dadosBancarios[].​agenciaobject or null(Agencia)required

Informações da Agência

dadosBancarios[].​agencia.​numerostring or nullrequired

Código da agência

dadosBancarios[].​agencia.​digitostring or nullrequired

Dígito da agência

dadosBancarios[].​contaobject or null(Conta)required

Informações da Conta

dadosBancarios[].​conta.​numerostring or nullrequired

Código da conta

dadosBancarios[].​conta.​digitostring or nullrequired

Dígito da conta

dadosBancarios[].​principalbooleanrequired

Indica se é a conta principal

dadosBancarios[].​chavesPixArray of objects or null(ChavesPix)required

Array de chaves Pix

dadosBancarios[].​chavesPix[].​tipointeger(TipoChavePixEnum)required

Tipo da chave Pix

dadosBancarios[].​chavesPix[].​chavestring or nullrequired

Chave Pix

apelidostring or nullrequired

Apelido do agente

comissaonumber(double)required

Comissão padrão do agente

statusinteger(StatusAgenteEnum)required

Status do agente

nivelHierarquicointeger(NivelAgenteEnum2)required

Nível hierárquico do agente

agentesAssociadosArray of strings or nullrequired

Array de ids dos agentes associados

usuarioIdAcessoSistemastring or nullrequired

Id do usuário principal

politicaComissaoAgenteIdstring or nullrequired

Id da política de comissão do agente

cedentesArray of strings or nullrequired

Array de ids dos cedentes

usuariosVisaoCarteiraArray of strings or nullrequired

Array de ids dos usuários com acesso a carteira

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes \
  -H 'Content-Type: application/json' \
  -d '{
    "tipoPessoa": 0,
    "pessoaFisica": {
      "cpf": "string",
      "telefones": [
        {
          "numero": "string",
          "tipo": 0,
          "principal": true,
          "whatsapp": true,
          "sms": true,
          "pessoaId": "string"
        }
      ],
      "emails": [
        {
          "email": "string",
          "principal": true,
          "pessoaId": "string"
        }
      ],
      "enderecos": [
        {
          "logradouro": "string",
          "numero": "string",
          "semNumero": true,
          "complemento": "string",
          "cep": "string",
          "bairro": "string",
          "municipio": "string",
          "uf": "string",
          "principal": true,
          "pessoaId": "string"
        }
      ],
      "acessos": [
        {
          "empresaId": "string",
          "tipoPessoaFisica": 0,
          "ativo": true
        }
      ],
      "setores": [
        {
          "id": "string"
        }
      ],
      "nome": "string",
      "login": "string",
      "perfilsId": [
        "string"
      ],
      "identidade": {
        "numero": "string",
        "emissao": "2019-08-24T14:15:22Z"
      },
      "nascimento": "2019-08-24T14:15:22Z",
      "site": "string",
      "tipoAutenticacaoDoisFatores": [
        0
      ]
    },
    "pessoaJuridica": {
      "cnpj": "string",
      "dataAbertura": "2019-08-24T14:15:22Z",
      "nomeEmpresarial": "string",
      "nomeFantasia": "string",
      "naturezaJuridica": "string",
      "situacaoCadastral": {
        "descricao": "string",
        "data": "2019-08-24T14:15:22Z",
        "motivo": "string"
      },
      "enderecoReceitaFederal": {
        "logradouro": "string",
        "numero": "string",
        "semNumero": true,
        "complemento": "string",
        "cep": "string",
        "bairro": "string",
        "municipio": "string",
        "uf": "string"
      },
      "emails": [
        null
      ],
      "telefones": [
        null
      ],
      "enderecos": [
        null
      ],
      "inscricaoEstadual": "string",
      "inscricaoMunicipal": "string",
      "matriz": true,
      "nire": "string",
      "site": "string",
      "tipoRegimeTributarioId": "string",
      "tipoPessoaJuridica": 0,
      "registroJuntaComercial": "string"
    },
    "dadosBancarios": [
      {
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "principal": true,
        "chavesPix": [
          {
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "apelido": "string",
    "comissao": 0.1,
    "status": 0,
    "nivelHierarquico": 0,
    "agentesAssociados": [
      "string"
    ],
    "usuarioIdAcessoSistema": "string",
    "politicaComissaoAgenteId": "string",
    "cedentes": [
      "string"
    ],
    "usuariosVisaoCarteira": [
      "string"
    ]
  }'

Responses

OK

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

Listar agentes de uma politica de comissao

Request

Lista todos os agentes de uma politica de comissao e um tenant específico

Path
idstringrequired

Id da politica de comissão de agentes

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ascendenteboolean

Indica se a ordenação da coluna nome será ascendete ou nao

Default true
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/gerencial/politicas/comissoes-agentes/{id}/agentes?quantidade=10&ascendente=true'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

ID do agente

nomestring or nullrequired

Nome do agente

nivelinteger(NivelAgenteEnum)required

Nivel do agente

statusinteger(StatusAgenteEnum)required

Status do agente

whatsappstring or nullrequired

Whatsapp do agente

possuiEmailbooleanrequired

Indica se o agente possui ou não email

possuiEnderecobooleanrequired

Indica se o agente possui ou não endereço

possuiDadoBancariobooleanrequired

Indica se o agente possui ou não dados bancários

]
Response
application/json
[
  {
    "id": "string",
    "nome": "string",
    "nivel": 0,
    "status": 0,
    "whatsapp": "string",
    "possuiEmail": true,
    "possuiEndereco": true,
    "possuiDadoBancario": true
  }
]

Listar agentes ativos

Request

Lista todos os agentes ativos de um tenant específico

Query
nomestring

Nome ou parte do nome do agente

Default null
nivelstring

Níveis de agente

Default null
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/ativos?quantidade=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

ID do agente

nomestring or nullrequired

Nome do agente

apelidostring or nullrequired

Apelido do agente

nivelinteger(NivelAgenteEnum3)required

Nível do agente

politicaComissaoAgenteIdstring or nullrequired

Id da política de comissão do agente

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

Recuperar agente por ID

Request

Recuperar agente do sistema por id

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

Responses

OK

Bodyapplication/json
apelidostring or nullrequired

Apelido do agente

statusinteger(StatusAgenteEnum)required

Status do agente

nivelHierarquicointeger(NivelAgenteEnum3)required

Nível do agente

comissaonumber or null(double)required

Comissão do agente

agentesAssociadosArray of objects or null(TenantAgenteAgentesAssociadosResponse)

Array de agentes associados

politicaComissaoAgenteobject or null(TenantAgentePoliticaComissaoAgenteResponse)required

Politica de comissao do agente

politicaComissaoAgente.​idstring or nullrequired

ID da política de comissão

politicaComissaoAgente.​nomestring or nullrequired

Nome da política de comissão

usuarioobject or null(UsuarioDadosResponse)

Dados do usuário

usuariosAcessoSistemaArray of objects or null(TenantAgenteUsuarioVisaoAcesso)

Usuários com acesso ao sistema

usuariosVisaoCarteiraArray of objects or null

Usuários com visibilidade a carteira do cliente

pessoaFisicaobject or null(PessoaFisicaCompletoResponse)

Dados da pessoa física

pessoaJuridicaobject or null(PessoaJuridicaResponse)

Dados da pessoa jurídica

emailsArray of objects or null

Array de emails

enderecosArray of objects or null

Array de endereços

telefonesArray of objects or null

Array de telefones

Response
application/json
{
  "apelido": "string",
  "status": 0,
  "nivelHierarquico": 0,
  "comissao": 0.1,
  "agentesAssociados": [
    { … }
  ],
  "politicaComissaoAgente": {
    "id": "string",
    "nome": "string"
  },
  "usuario": {
    "id": "string",
    "nome": "string",
    "cpf": "string",
    "login": "string",
    "perfis": [ … ],
    "identidade": { … },
    "nascimento": "2019-08-24T14:15:22Z",
    "site": "string",
    "tipoAutenticacaoDoisFatores": 0,
    "telefones": [ … ],
    "emails": [ … ],
    "enderecos": [ … ],
    "acessos": [ … ],
    "setores": [ … ]
  },
  "usuariosAcessoSistema": [
    { … }
  ],
  "usuariosVisaoCarteira": [
    null
  ],
  "pessoaFisica": {
    "identidade": "string",
    "emissaoIdentidade": "2019-08-24T14:15:22Z",
    "nascimento": "2019-08-24T14:15:22Z",
    "cpf": "string",
    "nome": "string",
    "site": "string"
  },
  "pessoaJuridica": {
    "cnpj": "string",
    "abertura": "2019-08-24T14:15:22Z",
    "nomeEmpresarial": "string",
    "nomeFantasia": "string",
    "naturezaJuridica": "string",
    "situacaoCadastral": { … },
    "inscricaoEstadual": "string",
    "inscricaoMunicipal": "string",
    "enderecoReceitaFederal": { … },
    "matriz": true,
    "nire": "string",
    "site": "string",
    "tipoRegimeTributarioId": "string",
    "tipoPessoaJuridica": 0,
    "registroJuntaComercial": "string",
    "ultimaAtualizacaoReceitaFederal": null
  },
  "emails": [
    null
  ],
  "enderecos": [
    null
  ],
  "telefones": [
    null
  ]
}

Alterar agente

Request

Alterar um agente no sistema

Path
idstringrequired

PessoaId do agente

Body
required
tipoPessoainteger(TipoPessoaEnum)required

Indica o tipo de pessoa

idstring or null

Id do agente

pessoaFisicaobject or null(PessoaFisicaAlterarRequest)required

Dados da pessoa física

pessoaFisica.​pessoaIdstring or nullrequired

Id da pessoa física

pessoaFisica.​emailsArray of objects or null(PessoaFisicaEmailAlterarRequest)required

Array com os emails da pessoa física

pessoaFisica.​emails[].​idstring or nullrequired

Id da entidade PessoaEmail

pessoaFisica.​emails[].​emailstring or nullrequired

Endereço de email

pessoaFisica.​emails[].​principalbooleanrequired

Indica se é o email principal

pessoaFisica.​emails[].​pessoaIdstring or null

Id da entidade pessoa

pessoaFisica.​telefonesArray of objects or null(PessoaFisicaTelefoneAlterarRequest)required

Array com os telefones da pessoa física

pessoaFisica.​telefones[].​idstring or nullrequired

Id da entidade PessoaTelefone

pessoaFisica.​telefones[].​numerostring or nullrequired

Número do telefone

pessoaFisica.​telefones[].​tipointeger(TipoTelefoneEnum)required

Tipo de telefone

pessoaFisica.​telefones[].​principalbooleanrequired

Indica se o telefone é o principal ou não

pessoaFisica.​telefones[].​whatsappbooleanrequired

Indica se o telefone recebe whatsapp ou não

pessoaFisica.​telefones[].​smsbooleanrequired

Indica se o telefone recebe sms ou não

pessoaFisica.​telefones[].​pessoaIdstring or null

Id da entidade pessoa

pessoaFisica.​enderecosArray of objects or null(PessoaFisicaEnderecoAlterarRequest)required

Array com os endereços da pessoa física

pessoaFisica.​enderecos[].​idstring or nullrequired

Id da entidade PessoaEndereco

pessoaFisica.​enderecos[].​logradourostring or nullrequired

Logradouro do endereço

pessoaFisica.​enderecos[].​numerostring or nullrequired

Número do endereço

pessoaFisica.​enderecos[].​semNumerobooleanrequired

Indica se o endereço possui número ou não

pessoaFisica.​enderecos[].​complementostring or nullrequired

Complemento do endereço

pessoaFisica.​enderecos[].​cepstring or nullrequired

Cep do endereço

pessoaFisica.​enderecos[].​bairrostring or nullrequired

Bairro do endereço

pessoaFisica.​enderecos[].​municipiostring or nullrequired

Município do endereço

pessoaFisica.​enderecos[].​ufstring or nullrequired

Uf do endereço

pessoaFisica.​enderecos[].​principalbooleanrequired

Indica se é o endereço principal

pessoaFisica.​enderecos[].​pessoaIdstring or null

Id da entidade pessoa

pessoaFisica.​nomestring or nullrequired

Nome da pessoa física

pessoaFisica.​identidadestring or nullrequired

Identidade da pessoa física

pessoaFisica.​emissaoIdentidadestring or null(date-time)required

Data da emissão da identidade da pessoa física

pessoaFisica.​nascimentostring or null(date-time)required

Data de nascimento da pessoa física

pessoaFisica.​sitestring or nullrequired

Site da pessa física

pessoaJuridicaobject or null(PessoaJuridicaAlterarRequest)required

Dados da pessoa jurídica

pessoaJuridica.​idstring or nullrequired

Id da pessoa jurídica

pessoaJuridica.​emailsArray of objects or nullrequired

Array com os emails da pessoa física

pessoaJuridica.​telefonesArray of objects or nullrequired

Array com os telefones da pessoa física

pessoaJuridica.​enderecosArray of objects or nullrequired

Array com os endereços da pessoa física

pessoaJuridica.​inscricaoEstadualstring or nullrequired

Inscrição estadual da pessoa jurídica

pessoaJuridica.​inscricaoMunicipalstring or nullrequired

Inscrição municipal da pessoa jurídica

pessoaJuridica.​matrizbooleanrequired

Indica se a empesa é matriz ou não

pessoaJuridica.​nirestring or nullrequired

Número de identificação do registro de empresas

pessoaJuridica.​sitestring or nullrequired

Url do site da empresa

pessoaJuridica.​tipoRegimeTributarioIdstring or nullrequired

Tipo do regime trubutário

pessoaJuridica.​tipoPessoaJuridicainteger(TipoPessoaJuridicaEnum)required

Tipo de pessoa jurídica

pessoaJuridica.​registroJuntaComercialstring or nullrequired

Registro da junta comercial

dadosBancariosArray of objects or null(PessoaInformacaoBancariaAlterarRequest)required

Dados bancários do agente

dadosBancarios[].​idstring or nullrequired

Id da entidade pessoa informação bancaria

dadosBancarios[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

dadosBancarios[].​bancoIdinteger(int16)required

Código do banco

dadosBancarios[].​agenciaobject or null(AgenciaAlterar)required

Informações da Agência

dadosBancarios[].​agencia.​numerostring or nullrequired

Código da agência

dadosBancarios[].​agencia.​digitostring or nullrequired

Dígito da agência

dadosBancarios[].​contaobject or null(ContaAlterar)required

Informações da Conta

dadosBancarios[].​conta.​numerostring or nullrequired

Código da conta

dadosBancarios[].​conta.​digitostring or nullrequired

Dígito da conta

dadosBancarios[].​principalbooleanrequired

Indica se é a conta principal

dadosBancarios[].​chavesPixArray of objects or null(ChavesPixAlterar)required

Array de chaves Pix

dadosBancarios[].​chavesPix[].​idstring or nullrequired

Id da chave Pix

dadosBancarios[].​chavesPix[].​tipointeger(TipoChavePixEnum)required

Tipo da chave Pix

dadosBancarios[].​chavesPix[].​chavestring or nullrequired

Chave Pix

usuariosAcessoArray of strings or nullrequired

Array de ids dos usuários com acesso ao sistema

apelidostring or nullrequired

Apelido do agente

comissaonumber(double)required

Comissão padrão do agente

statusinteger(StatusAgenteEnum)required

Status do agente

nivelHierarquicointeger(NivelAgenteEnum2)required

Nível hierárquico do agente

agentesAssociadosArray of strings or nullrequired

Array de ids dos agentes associados

usuarioIdAcessoSistemastring or nullrequired

Id do usuário principal

politicaComissaoAgenteIdstring or nullrequired

Id da política de comissão do agente

cedentesArray of strings or nullrequired

Array de ids dos cedentes

usuariosVisaoCarteiraArray of strings or nullrequired

Array de ids dos usuários com acesso a carteira

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "tipoPessoa": 0,
    "id": "string",
    "pessoaFisica": {
      "pessoaId": "string",
      "emails": [
        {
          "id": "string",
          "email": "string",
          "principal": true,
          "pessoaId": "string"
        }
      ],
      "telefones": [
        {
          "id": "string",
          "numero": "string",
          "tipo": 0,
          "principal": true,
          "whatsapp": true,
          "sms": true,
          "pessoaId": "string"
        }
      ],
      "enderecos": [
        {
          "id": "string",
          "logradouro": "string",
          "numero": "string",
          "semNumero": true,
          "complemento": "string",
          "cep": "string",
          "bairro": "string",
          "municipio": "string",
          "uf": "string",
          "principal": true,
          "pessoaId": "string"
        }
      ],
      "nome": "string",
      "identidade": "string",
      "emissaoIdentidade": "2019-08-24T14:15:22Z",
      "nascimento": "2019-08-24T14:15:22Z",
      "site": "string"
    },
    "pessoaJuridica": {
      "id": "string",
      "emails": [
        null
      ],
      "telefones": [
        null
      ],
      "enderecos": [
        null
      ],
      "inscricaoEstadual": "string",
      "inscricaoMunicipal": "string",
      "matriz": true,
      "nire": "string",
      "site": "string",
      "tipoRegimeTributarioId": "string",
      "tipoPessoaJuridica": 0,
      "registroJuntaComercial": "string"
    },
    "dadosBancarios": [
      {
        "id": "string",
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "principal": true,
        "chavesPix": [
          {
            "id": "string",
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "usuariosAcesso": [
      "string"
    ],
    "apelido": "string",
    "comissao": 0.1,
    "status": 0,
    "nivelHierarquico": 0,
    "agentesAssociados": [
      "string"
    ],
    "usuarioIdAcessoSistema": "string",
    "politicaComissaoAgenteId": "string",
    "cedentes": [
      "string"
    ],
    "usuariosVisaoCarteira": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

Excluir agente

Request

Excluir um agente no sistema por id

Path
idstringrequired

PessoaId do agente

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

Responses

OK

Bodyapplication/json
Response
application/json
null

Alterar politicia de comissao de um agente

Request

Alterar um agente no sistema

Path
idstringrequired

PessoaId do agente

Body
required
idstring or nullrequired

PessoaId do agente

politicaComissaoAgenteIdstring or nullrequired

Id da política de comissão do agente

curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/agentes/{id}/politicas/comissoes-agentes' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "politicaComissaoAgenteId": "string"
  }'

Responses

OK

Bodyapplication/json
politicaComissaoAgenteIdstring or nullrequired

PoliticaComissaoAgenteId

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

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