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.

Overview
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

Listar cedentes

Request

Listar cedentes do sistema

Query
idstring

Id do cedente

Default null
nomestring

Nome ou parte do nome do usuário

Default null
apelidostring

Apelido ou parte do apelido

Default null
statusstring

Lista de Status

Default null
ramoIdstring

Id do Ramo

Default null
cnaestring

CNAE

Default null
cpfCnpjstring

CPF ou CNPJ

Default null
cadastroInicialstring(date-time)

Data de cadastro inicial

Default null
cadastroFinalstring(date-time)

Data de cadastro final

Default null
visibilidadeIdsArray of strings

Array ids da pessoa física com visibilidade

Default null
grupoEmpresarialIdstring

Id do grupo empresarial

Default null
politicaLimiteIdstring

Id da politica de limites

Default null
politicaTaxaIdstring

Id da politica de taxa

Default null
politicaChecagemIdstring

Id da politica de checagem

Default null
agenteIdstring

Id do agente

Default null
revisaoInicialstring(date-time)

Data de revisão inicial

Default null
revisaoFinalstring(date-time)

Data de revisão final

Default null
paginainteger(int32)

Número da páginação

Default null
registrosinteger(int32)

Quantidade de registros a serem retornados

Default 10
ascendenteboolean

Ordenação da query

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

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

tipoPessoainteger(TipoPessoaEnum2)required

Tipo de Pessoa

cpfCnpjstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

cadastrostring(date-time)required

Data de Cadastro do Cedente

grupoEmpresarialobject or null(GrupoEmpresarialResponse)required

Grupo Empresarial do Cedente

grupoEmpresarial.​idstring or nullrequired

Id do Grupo Empresarial

grupoEmpresarial.​nomestring or nullrequired

Nome do Grupo Empresarial

agenteobject or null(AgentesResponse)required

Agentes do Cedente

agente.​idstring or nullrequired

Id do Agente

agente.​nomestring or nullrequired

Nome do Agente

ramoobject or null(RamoResponse)required

Ramo de Atividade do Cedente

ramo.​idstring or nullrequired

Id do Ramo de Atividade

ramo.​nomestring or nullrequired

Nome do Ramo de Atividade

cnaeobject or null(CnaeResponse)required

CNAE do Cedente

cnae.​idstring or nullrequired

Código do CNAE

cnae.​descricaostring or nullrequired

Descrição do CNAE

]
Response
application/json
[ { "id": "string", "tipoPessoa": 0, "cpfCnpj": "string", "nome": "string", "apelido": "string", "status": 0, "cadastro": "2019-08-24T14:15:22Z", "grupoEmpresarial": {}, "agente": {}, "ramo": {}, "cnae": {} } ]

Cadastrar cedente

Request

Cadastrar um cedente no sistema

Bodyrequired
tipoPessoainteger(TipoPessoaEnum3)required

Tipo de pessoa

pessoaFisicaobject or null(PessoaFisicaCadastrarRequest)required

Dados da pessoa Fisica

pessoaFisica.​cpfstring or nullrequired

Cpf da pessoa física

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

cnpjstring or nullrequired

Cnpj da pessoa Juridica

dadosBancariosArray of objects or null(PessoaInformacaoBancariaCadastrarRequest)required

Dados bancários do cedente

dadosBancarios[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

dadosBancarios[].​bancoIdinteger(int16)required

Código do banco

dadosBancarios[].​agenciaobject or null(AgenciaCadastrarRequest)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(ContaCadastrarRequest)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(ChavesPixCadastrarRequest)required

Array de chaves Pix

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

Tipo da chave Pix

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

Chave Pix

emailsArray of objects or null(PessoaEmailCadastrarRequest)required

Emails da empresa

emails[].​emailstring or nullrequired

Endereço de email

emails[].​principalbooleanrequired

Indica se é o email principal

telefonesArray of objects or null(PessoaTelefoneCadastrarRequest)required

Telefones da empresa

telefones[].​numerostring or nullrequired

Número do telefone

telefones[].​tipointeger(TipoTelefoneEnum)required

Tipo de telefone

telefones[].​principalbooleanrequired

Indica se o telefone é o principal ou não

telefones[].​whatsappbooleanrequired

Indica se o telefone recebe whatsapp ou não

telefones[].​smsbooleanrequired

Indica se o telefone recebe sms ou não

enderecosArray of objects or null(PessoaEnderecoCadastrarRequest)required

Endereços da empresa

enderecos[].​logradourostring or nullrequired

Logradouro do endereço

enderecos[].​numerostring or nullrequired

Número do endereço

enderecos[].​semNumerobooleanrequired

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

enderecos[].​complementostring or nullrequired

Complemento do endereço

enderecos[].​cepstring or nullrequired

Cep do endereço

enderecos[].​bairrostring or nullrequired

Bairro do endereço

enderecos[].​municipiostring or nullrequired

Município do endereço

enderecos[].​ufstring or nullrequired

Uf do endereço

enderecos[].​principalbooleanrequired

Indica se é o endereço principal

dadosFidcArray of objects or null(CedenteDadosFidcCadastrarRequest)required

Array com os dados do fidc do cedente

dadosFidc[].​empresaIdsArray of strings or nullrequired

Array de empresas

dadosFidc[].​classificacaoRiscointeger or null(NullableOfClassificacaoRiscoCedenteFidcEnum)required

Classificação de risco do cedente no Fidc selecionado

dadosFidc[].​sociedadeinteger or null(NullableOfTipoSociedadeCedenteFidcEnum)required

Tipo de Sociedade do cedente

dadosFidc[].​ramoFidcinteger or null(NullableOfTipoRamoCedenteFidcEnum)required

Tipo de Ramo de atividade do cedente conforme exigência do FIDC

dadosFidc[].​porteinteger or null(NullableOfTipoPorteCedenteFidcEnum)required

Tipo de Porte do cedente

dadosFidc[].​minimoAssinaturaTermointeger or null(uint8)required

Quantidade mínima de assinatura em conjunto para termo aditivo

dadosFidc[].​minimoAssinaturaDuplicatainteger or null(uint8)required

Quantidade mínima de assinatura em conjunto para duplicata

apelidostring or nullrequired

Apelido do cedente

ramoIdstring or nullrequired

Id do ramo do cedente

statusinteger(StatusCedenteEnum2)required

Status do cedente

grupoEmpresarialIdstring or nullrequired

Id do grupo empresarial

agenteIdstring or nullrequired

Id do agente

revisaoobject or null(AgendamentoRevisaoRequest)required

Data da revisão da política de taxa

revisao.​notificarbooleanrequired

Indica se vai haver notificação ou não

revisao.​revisaostring or null(date-time)required

Data da revisão

revisao.​diasAntecedenciainteger or null(int32)required

Dias em que a notificação deve ser iniciada

observacaostring or nullrequired

Observação do cedente

politicasobject or null(PoliticasRequest)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_cedentes_extend/api/v1/cedentes \
  -H 'Content-Type: application/json' \
  -d '{
    "tipoPessoa": 0,
    "pessoaFisica": {
      "cpf": "string",
      "nome": "string",
      "identidade": "string",
      "emissaoIdentidade": "2019-08-24T14:15:22Z",
      "nascimento": "2019-08-24T14:15:22Z",
      "site": "string"
    },
    "cnpj": "string",
    "dadosBancarios": [
      {
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "principal": true,
        "chavesPix": [
          {
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "emails": [
      {
        "email": "string",
        "principal": true
      }
    ],
    "telefones": [
      {
        "numero": "string",
        "tipo": 0,
        "principal": true,
        "whatsapp": true,
        "sms": true
      }
    ],
    "enderecos": [
      {
        "logradouro": "string",
        "numero": "string",
        "semNumero": true,
        "complemento": "string",
        "cep": "string",
        "bairro": "string",
        "municipio": "string",
        "uf": "string",
        "principal": true
      }
    ],
    "dadosFidc": [
      {
        "empresaIds": [
          "string"
        ],
        "classificacaoRisco": 0,
        "sociedade": 0,
        "ramoFidc": 0,
        "porte": 0,
        "minimoAssinaturaTermo": 0,
        "minimoAssinaturaDuplicata": 0
      }
    ],
    "apelido": "string",
    "ramoId": "string",
    "status": 0,
    "grupoEmpresarialId": "string",
    "agenteId": "string",
    "revisao": {
      "notificar": true,
      "revisao": "2019-08-24T14:15:22Z",
      "diasAntecedencia": 0
    },
    "observacao": "string",
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    }
  }'

Responses

OK

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

Listar cedentes da politica limite filtrada

Request

Listar cedentes da politica limite filtrada

Path
idstringrequired

Id da politica de limites

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

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

tipoPessoainteger(TipoPessoaEnum2)required

Tipo de Pessoa

cpfCnpjstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

cadastrostring(date-time)required

Data de Cadastro do Cedente

grupoEmpresarialobject or null(GrupoEmpresarialResponse)required

Grupo Empresarial do Cedente

grupoEmpresarial.​idstring or nullrequired

Id do Grupo Empresarial

grupoEmpresarial.​nomestring or nullrequired

Nome do Grupo Empresarial

agenteobject or null(AgentesResponse)required

Agentes do Cedente

agente.​idstring or nullrequired

Id do Agente

agente.​nomestring or nullrequired

Nome do Agente

ramoobject or null(RamoResponse)required

Ramo de Atividade do Cedente

ramo.​idstring or nullrequired

Id do Ramo de Atividade

ramo.​nomestring or nullrequired

Nome do Ramo de Atividade

cnaeobject or null(CnaeResponse)required

CNAE do Cedente

cnae.​idstring or nullrequired

Código do CNAE

cnae.​descricaostring or nullrequired

Descrição do CNAE

]
Response
application/json
[ { "id": "string", "tipoPessoa": 0, "cpfCnpj": "string", "nome": "string", "apelido": "string", "status": 0, "cadastro": "2019-08-24T14:15:22Z", "grupoEmpresarial": {}, "agente": {}, "ramo": {}, "cnae": {} } ]

Listar cedentes da politica taxa filtrada

Request

Listar cedentes da politica taxa filtrada

Path
idstringrequired

Id da politica de taxas

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

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

tipoPessoainteger(TipoPessoaEnum2)required

Tipo de Pessoa

cpfCnpjstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

cadastrostring(date-time)required

Data de Cadastro do Cedente

grupoEmpresarialobject or null(GrupoEmpresarialResponse)required

Grupo Empresarial do Cedente

grupoEmpresarial.​idstring or nullrequired

Id do Grupo Empresarial

grupoEmpresarial.​nomestring or nullrequired

Nome do Grupo Empresarial

agenteobject or null(AgentesResponse)required

Agentes do Cedente

agente.​idstring or nullrequired

Id do Agente

agente.​nomestring or nullrequired

Nome do Agente

ramoobject or null(RamoResponse)required

Ramo de Atividade do Cedente

ramo.​idstring or nullrequired

Id do Ramo de Atividade

ramo.​nomestring or nullrequired

Nome do Ramo de Atividade

cnaeobject or null(CnaeResponse)required

CNAE do Cedente

cnae.​idstring or nullrequired

Código do CNAE

cnae.​descricaostring or nullrequired

Descrição do CNAE

]
Response
application/json
[ { "id": "string", "tipoPessoa": 0, "cpfCnpj": "string", "nome": "string", "apelido": "string", "status": 0, "cadastro": "2019-08-24T14:15:22Z", "grupoEmpresarial": {}, "agente": {}, "ramo": {}, "cnae": {} } ]

Listar cedentes da politica checagem filtrada

Request

Listar cedentes da politica checagem filtrada

Path
idstringrequired

Id da politica de checagens

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

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

tipoPessoainteger(TipoPessoaEnum2)required

Tipo de Pessoa

cpfCnpjstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

cadastrostring(date-time)required

Data de Cadastro do Cedente

grupoEmpresarialobject or null(GrupoEmpresarialResponse)required

Grupo Empresarial do Cedente

grupoEmpresarial.​idstring or nullrequired

Id do Grupo Empresarial

grupoEmpresarial.​nomestring or nullrequired

Nome do Grupo Empresarial

agenteobject or null(AgentesResponse)required

Agentes do Cedente

agente.​idstring or nullrequired

Id do Agente

agente.​nomestring or nullrequired

Nome do Agente

ramoobject or null(RamoResponse)required

Ramo de Atividade do Cedente

ramo.​idstring or nullrequired

Id do Ramo de Atividade

ramo.​nomestring or nullrequired

Nome do Ramo de Atividade

cnaeobject or null(CnaeResponse)required

CNAE do Cedente

cnae.​idstring or nullrequired

Código do CNAE

cnae.​descricaostring or nullrequired

Descrição do CNAE

]
Response
application/json
[ { "id": "string", "tipoPessoa": 0, "cpfCnpj": "string", "nome": "string", "apelido": "string", "status": 0, "cadastro": "2019-08-24T14:15:22Z", "grupoEmpresarial": {}, "agente": {}, "ramo": {}, "cnae": {} } ]

Listar cedentes do agente filtrado

Request

Listar cedentes do agente filtrado

Path
idstringrequired

Id do agente

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ascendenteboolean

Ordenação da query

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

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

tipoPessoainteger(TipoPessoaEnum2)required

Tipo de Pessoa

cpfCnpjstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

cadastrostring(date-time)required

Data de Cadastro do Cedente

grupoEmpresarialobject or null(GrupoEmpresarialResponse)required

Grupo Empresarial do Cedente

grupoEmpresarial.​idstring or nullrequired

Id do Grupo Empresarial

grupoEmpresarial.​nomestring or nullrequired

Nome do Grupo Empresarial

agenteobject or null(AgentesResponse)required

Agentes do Cedente

agente.​idstring or nullrequired

Id do Agente

agente.​nomestring or nullrequired

Nome do Agente

ramoobject or null(RamoResponse)required

Ramo de Atividade do Cedente

ramo.​idstring or nullrequired

Id do Ramo de Atividade

ramo.​nomestring or nullrequired

Nome do Ramo de Atividade

cnaeobject or null(CnaeResponse)required

CNAE do Cedente

cnae.​idstring or nullrequired

Código do CNAE

cnae.​descricaostring or nullrequired

Descrição do CNAE

]
Response
application/json
[ { "id": "string", "tipoPessoa": 0, "cpfCnpj": "string", "nome": "string", "apelido": "string", "status": 0, "cadastro": "2019-08-24T14:15:22Z", "grupoEmpresarial": {}, "agente": {}, "ramo": {}, "cnae": {} } ]

Listar cedentes ativos

Request

Listar cedentes ativos do sistema

Query
nomestring

Nome ou parte do nome do usuário

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/cedentes/ativos?quantidade=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

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

Recuperar cedente por ID

Request

Recuperar cedente do sistema por id

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

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id do cedente

tipoPessoainteger(TipoPessoaEnum4)required

Tipo de Pessoa do cedente

apelidostring or nullrequired

Apelido do cedente

observacaostring or nullrequired

Observaçao do cedente

statusinteger(StatusCedenteEnum3)required

Grupo empresarial do cedente

ramoobject or null(IdENomeResponse)required

Ramo do cedente

ramo.​idstring or nullrequired
ramo.​nomestring or nullrequired
grupoEmpresarialobject or null(IdENomeResponse2)required

Status do cedente

grupoEmpresarial.​idstring or nullrequired
grupoEmpresarial.​nomestring or nullrequired
pessoaFisicaobject or null(PessoaFisicaCompletoResponse2)required

Dados da Pessoa Física do cedente

pessoaFisica.​identidadestring or nullrequired

Identidade da pessoa

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

Data de emissão da identidade

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

Data de nascimento da pessoa

pessoaFisica.​idstring or nullrequired

Id da pessoa

pessoaFisica.​cpfstring or nullrequired

CPF da pessoa

pessoaFisica.​nomestring or nullrequired

Nome da pessoa

pessoaFisica.​sitestring or nullrequired

Site da pessoa

pessoaJuridicaobject or null(PessoaJuridicaResponse2)required

Dados da Pessoa Jurídica do cedente

pessoaJuridica.​pessoaIdstring or nullrequired

Id único da pessoa

pessoaJuridica.​cnpjstring or nullrequired

CNPJ da pessoa jurídica

pessoaJuridica.​aberturastring or null(date-time)required

Data de 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(SituacaoCadastralResponse)required

Situação cadastral da pessoa jurídica

pessoaJuridica.​situacaoCadastral.​descricaostring or nullrequired

Descrição da situação cadastral

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

Data da situação cadastral

pessoaJuridica.​situacaoCadastral.​motivostring or nullrequired

Motivo da situação cadastral

pessoaJuridica.​inscricaoEstadualstring or nullrequired

Inscrição estadual da pessoa jurídica

pessoaJuridica.​inscricaoMunicipalstring or nullrequired

Inscrição municipal da pessoa jurídica

pessoaJuridica.​enderecoReceitaFederalobject or null(PessoaEnderecoReceitaFederalResponse)required

Endereço da 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.​semNumeroboolean or nullrequired

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

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.​matrizboolean or nullrequired

Indica se a pessoa jurídica é matriz

pessoaJuridica.​nirestring or nullrequired

Número de Inscrição do Registro de Empresas (NIRE) da pessoa jurídica

pessoaJuridica.​sitestring or nullrequired

Site da pessoa jurídica

pessoaJuridica.​tipoRegimeTributariostring or nullrequired

Tipo de regime tributário da pessoa jurídica

pessoaJuridica.​tipoPessoaJuridicastring or nullrequired

Tipo de pessoa jurídica

pessoaJuridica.​registroJuntaComercialstring or nullrequired

Registro na Junta Comercial da pessoa jurídica

pessoaJuridica.​cnaesArray of objects or null(PessoaJuridicaCnaeResponse)required

CNAEs da pessoa jurídica

pessoaJuridica.​cnaes[].​subClassestring or nullrequired

Identificador do CNAE da pessoa jurídica

pessoaJuridica.​cnaes[].​descricaostring or nullrequired

Descrição do CNAE da pessoa jurídica

pessoaJuridica.​cnaes[].​principalbooleanrequired

Indica se o CNAE da pessoa jurídica é o principal ou não

pessoaJuridica.​ultimaAtualizacaoReceitaFederalstring or null(date-time)required

Data da última atualização na Receita Federal

pessoaJuridica.​statusSincronizacaointeger or null(NullableOfStatusAtuallizacaoPessoaJuridicaEnum)required

Status da última sincronização de dados

pessoaJuridica.​mensagemErroSincronizacaostring or nullrequired

Mensagem de erro da última sincronização de dados

emailsArray of objects or null(PessoaEmailResponse)required

Lista de Emails do cedente

emails[].​idstring or nullrequired

Id do email

emails[].​emailstring or nullrequired

Email

emails[].​principalbooleanrequired

Indica se é o email principal

enderecosArray of objects or null(PessoaEnderecoResponse)required

Lista de Endereços do cedente

enderecos[].​idstring or nullrequired

Id do endereço

enderecos[].​principalbooleanrequired

Indica se é o endereço principal

enderecos[].​logradourostring or nullrequired

Endereço da pessoa

enderecos[].​numerostring or nullrequired

Número do endereço da pessoa

enderecos[].​semNumeroboolean or nullrequired

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

enderecos[].​complementostring or nullrequired

Complemento do endereço da pessoa

enderecos[].​cepstring or nullrequired

CEP do endereço da pessoa

enderecos[].​bairrostring or nullrequired

Bairro do endereço da pessoa

enderecos[].​municipiostring or nullrequired

Município do endereço da pessoa

enderecos[].​ufstring or nullrequired

UF do endereço da pessoa

telefonesArray of objects or null(PessoaTelefoneResponse)required

Lista de Telefones do cedente

telefones[].​idstring or nullrequired

Id do telefone

telefones[].​tipointeger(TipoTelefoneEnum2)required

Tipo do telefone

telefones[].​numerostring or nullrequired

Número do telefone

telefones[].​principalbooleanrequired

Indica se é o telefone principal

telefones[].​whatsappbooleanrequired

Indica se o telefone tem WhatsApp

telefones[].​smsbooleanrequired

Indica se o telefone tem SMS

dadosBancariosArray of objects or null(PessoaInformacaoBancariaResponse)required

Lista de Dados Bancários do cedente

dadosBancarios[].​idstring or nullrequired

Identificador único da informação bancária

dadosBancarios[].​tipoContainteger(TipoContaBancariaEnum)required

Tipo da conta bancária

dadosBancarios[].​bancoobject or null(BancoResponse)required

Informações do banco

dadosBancarios[].​banco.​idinteger(int16)required

Identificador único do banco

dadosBancarios[].​banco.​nomestring or nullrequired

Nome do banco

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

Informações da agência

dadosBancarios[].​agencia.​numerostring or nullrequired

Número da agência

dadosBancarios[].​agencia.​digitostring or nullrequired

Dígito verificador da agência

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

Informações da conta

dadosBancarios[].​conta.​numerostring or nullrequired

Número da conta

dadosBancarios[].​conta.​digitostring or nullrequired

Dígito verificador da conta

dadosBancarios[].​principalbooleanrequired

Indica se esta é a conta bancária principal

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

Lista de chaves PIX associadas à conta

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

Identificador único da chave pix

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

Tipo da chave PIX (CPF, CNPJ, E-mail, Telefone, Aleatória)

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

Valor da chave PIX

dadosFidcArray of objects or null(CedenteDadosFidcResponse)required

Lista de dados fidc do cedente

dadosFidc[].​idstring or nullrequired

Id dos dados do fidc

dadosFidc[].​empresaIdsArray of strings or nullrequired

Id das emrpesas dos dados fidc

dadosFidc[].​classificacaoRiscointeger or null(NullableOfClassificacaoRiscoCedenteFidcEnum)required

Classificação de risco do cedente no Fidc selecionado

dadosFidc[].​sociedadeinteger or null(NullableOfTipoSociedadeCedenteFidcEnum)required

Tipo de Sociedade do cedente

dadosFidc[].​ramoFidcinteger or null(NullableOfTipoRamoCedenteFidcEnum)required

Tipo de Ramo de atividade do cedente conforme exigência do FIDC

dadosFidc[].​porteinteger or null(NullableOfTipoPorteCedenteFidcEnum)required

Tipo de Porte do cedente

dadosFidc[].​minimoAssinaturaTermointeger or null(uint8)required

Quantidade mínima de assinatura em conjunto para termo aditivo

dadosFidc[].​minimoAssinaturaDuplicatainteger or null(uint8)required

Quantidade mínima de assinatura em conjunto para duplicata

agenteobject or null(TenantAgenteAtivoResponse2)required

Dados do agente do cedente

agente.​idstring or nullrequired

ID do agente

agente.​nomestring or nullrequired

Nome do agente

agente.​apelidostring or nullrequired

Apelido do agente

agente.​nivelinteger(NivelAgenteEnum3)required

Nível do agente

agente.​politicaComissaoAgenteIdstring or nullrequired

Id da política de comissão do agente

revisaoobject or null(AgendamentoRevisaoResponse)required

Dados do agendamento do cedente

revisao.​notificarbooleanrequired

Indica se vai haver notificação ou não

revisao.​revisaostring(date-time)required

Data da revisão

revisao.​diasAntecedenciainteger or null(int32)required

Dias em que a notificação deve ser iniciada

Response
application/json
{ "id": "string", "tipoPessoa": 0, "apelido": "string", "observacao": "string", "status": 0, "ramo": { "id": "string", "nome": "string" }, "grupoEmpresarial": { "id": "string", "nome": "string" }, "pessoaFisica": { "identidade": "string", "emissaoIdentidade": "2019-08-24T14:15:22Z", "nascimento": "2019-08-24T14:15:22Z", "id": "string", "cpf": "string", "nome": "string", "site": "string" }, "pessoaJuridica": { "pessoaId": "string", "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", "tipoRegimeTributario": "string", "tipoPessoaJuridica": "string", "registroJuntaComercial": "string", "cnaes": [], "ultimaAtualizacaoReceitaFederal": "2019-08-24T14:15:22Z", "statusSincronizacao": 0, "mensagemErroSincronizacao": "string" }, "emails": [ {} ], "enderecos": [ {} ], "telefones": [ {} ], "dadosBancarios": [ {} ], "dadosFidc": [ {} ], "agente": { "id": "string", "nome": "string", "apelido": "string", "nivel": 0, "politicaComissaoAgenteId": "string" }, "revisao": { "notificar": true, "revisao": "2019-08-24T14:15:22Z", "diasAntecedencia": 0 } }

Alterar cedente

Request

Alterar um cedente do sistema

Path
idstringrequired
Bodyrequired
pessoaFisicaobject or null(PessoaFisicaAlterarRequest2)required

Dados da pessoa Fisica

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

dadosBancariosArray of objects or null(PessoaInformacaoBancariaAlterarRequest)required

Dados bancários do cedente

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(AgenciaAlterarRequest)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(ContaAlterarRequest)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(ChavesPixAlterarRequest)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

emailsArray of objects or null(PessoaEmailAlterarRequest)required

Emails da empresa

emails[].​idstring or nullrequired

Id da entidade PessoaEmail

emails[].​emailstring or nullrequired

Endereço de email

emails[].​principalbooleanrequired

Indica se é o email principal

telefonesArray of objects or null(PessoaTelefoneAlterarRequest)required

Telefones da empresa

telefones[].​idstring or nullrequired

Id da entidade PessoaTelefone

telefones[].​numerostring or nullrequired

Número do telefone

telefones[].​tipointeger(TipoTelefoneEnum)required

Tipo de telefone

telefones[].​principalbooleanrequired

Indica se o telefone é o principal ou não

telefones[].​whatsappbooleanrequired

Indica se o telefone recebe whatsapp ou não

telefones[].​smsbooleanrequired

Indica se o telefone recebe sms ou não

enderecosArray of objects or null(PessoaEnderecoAlterarRequest)required

Endereços da empresa

enderecos[].​idstring or nullrequired

Id da entidade PessoaEndereco

enderecos[].​logradourostring or nullrequired

Logradouro do endereço

enderecos[].​numerostring or nullrequired

Número do endereço

enderecos[].​semNumerobooleanrequired

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

enderecos[].​complementostring or nullrequired

Complemento do endereço

enderecos[].​cepstring or nullrequired

Cep do endereço

enderecos[].​bairrostring or nullrequired

Bairro do endereço

enderecos[].​municipiostring or nullrequired

Município do endereço

enderecos[].​ufstring or nullrequired

Uf do endereço

enderecos[].​principalbooleanrequired

Indica se é o endereço principal

dadosFidcArray of objects or null(CedenteDadosFidcAlterarRequest)required

Array com os dados do fidc do cedente

dadosFidc[].​idstring or nullrequired

Id dos dados do fidc

dadosFidc[].​empresaIdsArray of strings or nullrequired

Array de empresas

dadosFidc[].​classificacaoRiscointeger or null(NullableOfClassificacaoRiscoCedenteFidcEnum)required

Classificação de risco do cedente no Fidc selecionado

dadosFidc[].​sociedadeinteger or null(NullableOfTipoSociedadeCedenteFidcEnum)required

Tipo de Sociedade do cedente

dadosFidc[].​ramoFidcinteger or null(NullableOfTipoRamoCedenteFidcEnum)required

Tipo de Ramo de atividade do cedente conforme exigência do FIDC

dadosFidc[].​porteinteger or null(NullableOfTipoPorteCedenteFidcEnum)required

Tipo de Porte do cedente

dadosFidc[].​minimoAssinaturaTermointeger or null(uint8)required

Quantidade mínima de assinatura em conjunto para termo aditivo

dadosFidc[].​minimoAssinaturaDuplicatainteger or null(uint8)required

Quantidade mínima de assinatura em conjunto para duplicata

apelidostring or nullrequired

Apelido do cedente

ramoIdstring or nullrequired

Id do ramo do cedente

statusinteger(StatusCedenteEnum2)required

Status do cedente

grupoEmpresarialIdstring or nullrequired

Id do grupo empresarial

agenteIdstring or nullrequired

Id do agente

revisaoobject or null(AgendamentoRevisaoRequest)required

Data da revisão da política de taxa

revisao.​notificarbooleanrequired

Indica se vai haver notificação ou não

revisao.​revisaostring or null(date-time)required

Data da revisão

revisao.​diasAntecedenciainteger or null(int32)required

Dias em que a notificação deve ser iniciada

observacaostring or nullrequired

Observação do cedente

politicasobject or null(PoliticasRequest)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_cedentes_extend/api/v1/cedentes/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "pessoaFisica": {
      "nome": "string",
      "identidade": "string",
      "emissaoIdentidade": "2019-08-24T14:15:22Z",
      "nascimento": "2019-08-24T14:15:22Z",
      "site": "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"
          }
        ]
      }
    ],
    "emails": [
      {
        "id": "string",
        "email": "string",
        "principal": true
      }
    ],
    "telefones": [
      {
        "id": "string",
        "numero": "string",
        "tipo": 0,
        "principal": true,
        "whatsapp": true,
        "sms": true
      }
    ],
    "enderecos": [
      {
        "id": "string",
        "logradouro": "string",
        "numero": "string",
        "semNumero": true,
        "complemento": "string",
        "cep": "string",
        "bairro": "string",
        "municipio": "string",
        "uf": "string",
        "principal": true
      }
    ],
    "dadosFidc": [
      {
        "id": "string",
        "empresaIds": [
          "string"
        ],
        "classificacaoRisco": 0,
        "sociedade": 0,
        "ramoFidc": 0,
        "porte": 0,
        "minimoAssinaturaTermo": 0,
        "minimoAssinaturaDuplicata": 0
      }
    ],
    "apelido": "string",
    "ramoId": "string",
    "status": 0,
    "grupoEmpresarialId": "string",
    "agenteId": "string",
    "revisao": {
      "notificar": true,
      "revisao": "2019-08-24T14:15:22Z",
      "diasAntecedencia": 0
    },
    "observacao": "string",
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    }
  }'

Responses

OK

Bodyapplication/json
Response
application/json
null

Excluir cedente

Request

Excluir um cedente

Path
idstringrequired

Id do registro a ser excluído

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

Responses

OK

Bodyapplication/json
Response
application/json
null

Politicas Checagens

Operations

Politicas Limites

Operations

Politicas Taxas

Operations