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

Listar cedentes

Request

Listar cedentes do sistema

Query
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
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
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/cedentes?quantidade=10&ascendente=true'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do Cedente

tipoPessoainteger(TipoPessoaEnum2)required

Tipo de Pessoa

cnpjCpfstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

]
Response
application/json
[
  {
    "id": "string",
    "tipoPessoa": 0,
    "cnpjCpf": "string",
    "nome": "string",
    "apelido": "string",
    "status": 0
  }
]

Cadastrar cedente

Request

Cadastrar um cedente no sistema

Body
required
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.​emailsArray of objects or null(PessoaFisicaEmailCadastrarRequest)required

Array com os emails da pessoa física

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(PessoaFisicaTelefoneCadastrarRequest)required

Array com os telefones da pessoa física

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(PessoaFisicaEnderecoCadastrarRequest)required

Array com os endereços da pessoa física

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(PessoaJuridicaCadastrarRequest2)required

Dados da pessoa Juridica

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

emailsArray of objects or nullrequired

Array com os emails do cedente

telefonesArray of objects or nullrequired

Array com os telefones do cedente

enderecosArray of objects or nullrequired

Array com os endereços do cedente

apelidostring or nullrequired

Apelido do cedente

statusinteger(StatusCedenteEnum2)required

Status do cedente

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",
      "emails": [
        {
          "email": "string",
          "principal": true,
          "pessoaId": "string"
        }
      ],
      "telefones": [
        {
          "numero": "string",
          "tipo": 0,
          "principal": true,
          "whatsapp": true,
          "sms": true,
          "pessoaId": "string"
        }
      ],
      "enderecos": [
        {
          "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": {
      "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"
    },
    "emails": [
      null
    ],
    "telefones": [
      null
    ],
    "enderecos": [
      null
    ],
    "apelido": "string",
    "status": 0
  }'

Responses

OK

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

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

cnpjCpfstring or nullrequired

CNPJ ou CPF

nomestring or nullrequired

Nome do Cedente

apelidostring or nullrequired

Apelido do Cedente

statusinteger(StatusCedenteEnum)required

Status do Cedente

]
Response
application/json
[
  {
    "id": "string",
    "tipoPessoa": 0,
    "cnpjCpf": "string",
    "nome": "string",
    "apelido": "string",
    "status": 0
  }
]

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

statusinteger(StatusCedenteEnum)required

Status do Cedente

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

CNPJ da pessoa jurídica

pessoaJuridica.​aberturastring(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.​semNumerobooleanrequired

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.​matrizbooleanrequired

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

Tipo de regime tributário da pessoa jurídica

pessoaJuridica.​tipoPessoaJuridicainteger(TipoPessoaJuridicaEnum)required

Tipo de pessoa jurídica

pessoaJuridica.​registroJuntaComercialstring or nullrequired

Registro na Junta Comercial da pessoa jurídica

pessoaJuridica.​ultimaAtualizacaoReceitaFederalstring or null(date-time)

Data da última atualização na Receita Federal

Default null
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[].​semNumerobooleanrequired

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

Response
application/json
{
  "id": "string",
  "tipoPessoa": 0,
  "apelido": "string",
  "status": 0,
  "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": [
    { … }
  ],
  "enderecos": [
    { … }
  ],
  "telefones": [
    { … }
  ]
}

Alterar cedente

Request

Alterar um cedente do sistema

Path
idstringrequired
Body
required
idstring or nullrequired

Id do cedente

pessoaFisicaobject or null(PessoaFisicaAlterarRequest2)required

Dados da pessoa Fisica

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(PessoaJuridicaAlterarRequest2)required

Dados da pessoa Juridica

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

emailsArray of objects or nullrequired

Array com os emails do cedente

telefonesArray of objects or nullrequired

Array com os telefones do cedente

enderecosArray of objects or nullrequired

Array com os endereços do cedente

apelidostring or nullrequired

Apelido do cedente

statusinteger(StatusCedenteEnum2)required

Status do cedente

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/api_cedentes_extend/api/v1/cedentes/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
    },
    "emails": [
      null
    ],
    "telefones": [
      null
    ],
    "enderecos": [
      null
    ],
    "apelido": "string",
    "status": 0
  }'

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