Skip to content

Sacado Api (v1.0.0)

API Sacado

A API Sacado foi desenvolvida para oferecer um controle abrangente e eficiente sobre os dados de sacados no sistema. Com ela, é possível gerenciar todas as informações relacionadas aos sacados, incluindo cadastro, alteração, consulta e exclusão, além de funcionalidades específicas para consultas por políticas associadas.

Simplificando a gestão de dados de sacados com o poder e a flexibilidade de uma API de alta performance!

A seguir, detalhamos as principais funcionalidades oferecidas pelos endpoints.

Download OpenAPI description
api_sacados_extend.json
api_sacados_extend.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/api_sacados_extend/
http://rgbsys.dyndns.info/ger2025-sacado-api-desenvolvimento/

Sacados

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

  • Cadastrar Sacado:
    • Cria um novo sacado no sistema.
  • Alterar Sacado:
    • Atualiza os dados de um sacado existente pelo seu identificador.
  • Excluir Sacado:
    • Remove um sacado do sistema pelo seu identificador.
  • Listar Sacados:
    • Recupera todos os sacados com opções de filtragem por nome, tipo de pessoa, CPF/CNPJ, status ativo, datas de cadastro, políticas associadas e paginação.
  • Consultar Sacado por ID:
    • Busca um sacado específico pelo seu identificador único.
  • Listar Sacados Ativos:
    • Recupera somente os sacados que estão ativos no sistema com opções de filtragem por nome e paginação.
  • Listar Sacados por Política de Limites:
    • Recupera sacados associados a uma política de limites específica.
  • Listar Sacados por Política de Taxas:
    • Recupera sacados associados a uma política de taxas específica.
  • Listar Sacados por Política de Checagens:
    • Recupera sacados associados a uma política de checagens específica.
Operations

Listar sacados

Request

Lista todos os sacados de um tenant específico

Query
nomestring

Nome ou parte do nome ou apelido do sacado

Default null
tipoPessoastring

Tipo de pessoa

Default null
cpfCnpjstring

Cpf ou cnpj ou raiz do cnpj do sacado

Default null
ativoboolean

Indica se o sacado está ativo ou não

Default null
cadastroInicialstring(date-time)

Data da criação do sacado

Default null
cadastroFinalstring(date-time)

Data da criação do sacado

Default null
grupoEmpresarialIdstring

Id do grupo empresarial

Default null
politicaLimiteIdstring

Id da politica de limites

Default null
politicaTaxaIdstring

Id da politica de taxas

Default null
politicaChecagemIdstring

Id da politica de checagem

Default null
paginainteger(int32)

Número da páginação

Default 1
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

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_sacados_extend/api/v1/sacados?pagina=1&quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Cadastrar sacado

Request

Cadastrar um sacado no sistema

Body
required
tipoPessoainteger(TipoPessoaEnum)required

Indica o 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(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[].​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

politicasobject or null(PoliticasCadastrar)required

Políticas associadas à empresa

politicas.​limiteArray of strings or nullrequired

Array com os ids das políticas de limite

politicas.​taxaArray of strings or nullrequired

Array com os ids das políticas de taxa

politicas.​checagemArray of strings or nullrequired

Array com os ids das políticas de checagem

apelidostring or nullrequired

Apelido do sacado

observacaostring or nullrequired

Observação do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

arquivosArray of strings or null(binary)(IFormFile)required

Arquivos do sacado

curl -i -X POST \
  https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados \
  -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"
    },
    "dadosBancarios": [
      {
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "chavesPix": [
          {
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    },
    "apelido": "string",
    "observacao": "string",
    "ativo": true,
    "arquivos": [
      "string"
    ]
  }'

Responses

OK

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

Listar sacados pela politica de limites

Request

Lista todos os sacados de um tenant específico pela politica de limites

Path
idstringrequired

Id da politica de limites

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

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_sacados_extend/api/v1/gerencial/politicas/limites/{id}/sacados?quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Listar sacados pela politica de taxas

Request

Lista todos os sacados de um tenant específico pela politica de taxas

Path
idstringrequired

Id da politica de taxas

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

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_sacados_extend/api/v1/gerencial/politicas/taxas/{id}/sacados?quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Listar sacados pela politica de checagens

Request

Lista todos os sacados de um tenant específico pela politica de checagens

Path
idstringrequired

Id da politica de checagens

Default null
Query
paginainteger(int32)

Número da páginação

Default null
quantidadeinteger(int32)

Quantidade de registros a serem retornados

Default 10
ordemboolean

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_sacados_extend/api/v1/gerencial/politicas/checagens/{id}/sacados?quantidade=10&ordem=true'

Responses

OK

Bodyapplication/jsonArray [
tipointeger(TipoPessoaEnum)required

Indica o tipo de pessoa

cpfCnpjstring or nullrequired

Cpf ou Cnpj do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

dataCadastrostring(date-time)required

Data da criação do sacado

idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

]
Response
application/json
[
  {
    "tipo": 0,
    "cpfCnpj": "string",
    "ativo": true,
    "dataCadastro": "2019-08-24T14:15:22Z",
    "id": "string",
    "nome": "string",
    "apelido": "string"
  }
]

Listar sacados ativos

Request

Lista todos os sacados ativos de um tenant específico

Query
nomestring

Nome ou parte do nome ou apelido do sacado

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_sacados_extend/api/v1/sacados/ativos?quantidade=10'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id do sacado

nomestring or nullrequired

Nome do sacado

apelidostring or nullrequired

Apelido do sacado

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

Recuperar sacado por ID

Request

Recuperar sacado do sistema por id

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

Responses

OK

Bodyapplication/json
apelidostring or nullrequired

Apelido do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

observacaostring or nullrequired

Observação do sacado

arquivosArray of strings or null(binary)(IFormFile)

Arquivos do sacado

pessoaFisicaobject or null(PessoaFisicaCompletoResponse)

Dados da pessoa física

pessoaJuridicaobject or null(PessoaJuridicaResponse)

Dados da pessoa jurídica

Response
application/json
{
  "apelido": "string",
  "ativo": true,
  "observacao": "string",
  "arquivos": [
    "string"
  ],
  "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
  }
}

Alterar sacado

Request

Alterar um sacado no sistema

Path
idstringrequired

Id do sacado

Body
required
idstring or null

Id do sacado

pessoaFisicaobject or null(PessoaFisicaAlterarRequest)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(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[].​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

politicasobject or null(PoliticasAlterar)required

Políticas associadas à empresa

politicas.​limiteArray of strings or nullrequired

Array com os ids das políticas de limite

politicas.​taxaArray of strings or nullrequired

Array com os ids das políticas de taxa

politicas.​checagemArray of strings or nullrequired

Array com os ids das políticas de checagem

apelidostring or nullrequired

Apelido do sacado

observacaostring or nullrequired

Observação do sacado

ativobooleanrequired

Indica se o sacado está ativo ou não

arquivosArray of strings or null(binary)(IFormFile)required

Arquivos do sacado

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/api_sacados_extend/api/v1/sacados/{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"
    },
    "dadosBancarios": [
      {
        "id": "string",
        "tipoConta": 0,
        "bancoId": 0,
        "agencia": {
          "numero": "string",
          "digito": "string"
        },
        "conta": {
          "numero": "string",
          "digito": "string"
        },
        "chavesPix": [
          {
            "id": "string",
            "tipo": 0,
            "chave": "string"
          }
        ]
      }
    ],
    "politicas": {
      "limite": [
        "string"
      ],
      "taxa": [
        "string"
      ],
      "checagem": [
        "string"
      ]
    },
    "apelido": "string",
    "observacao": "string",
    "ativo": true,
    "arquivos": [
      "string"
    ]
  }'

Responses

OK

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

Excluir sacado

Request

Excluir um sacado no sistema

Path
idstringrequired

Id do sacado

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

Responses

OK

Bodyapplication/json
Response
application/json
null

Politicas Checagens

Operations

Politicas Limites

Operations

Politicas Taxas

Operations