1. Raiz
API RESTFul Qgestora
  • API RESTful Qgestora
    • Raiz
      • Importar Pessoa/Limite de Crédito
        POST
      • Validar Importação de Operação
        POST
      • Realizar Envio de Operações (Remessas)
        POST
      • Envio de Documentação de Lastro
        POST
      • Receber Notificação de Operações (Remessas) — Webhook
        POST
      • Importar Cedente/Limite de Crédito
        POST
    • Schemas
      • ValidateImportCnabRequest
      • ImportCnabRequest
      • ImportReceivableDocumentationRequest
      • ReceivableDocumentationFile
      • ReturnCnabSituationRequest
      • CnabInformation
      • ExceptionResponse
      • ExceptionResponseError
      • TransferorData
      • TransferorCreditLimit
      • ImportTransferorLimitRequest
      • ImportTransferorLimitResponse
      • PersonData
      • PersonCreditLimit
      • ImportPersonLimitRequest
      • ImportPersonLimitResponse
      • ImportMessage
  • API RESTful Qgestora - Cancelamento de Operações (Estorno e Rejeição)
    • Raiz
      • Cancelar Operação
    • Schemas
      • OperationCancellationRequest
      • ExceptionResponse
      • ExceptionResponseError
  1. Raiz

Importar Pessoa/Limite de Crédito

POST
/v1/import-person-limit
Importa o cadastro de uma ou mais pessoas e/ou seus limites de crédito para inclusão/atualização na base do Qgestora. Na versão 4.0, a importação está disponível apenas para pessoas do tipo Cedente.

Através dessa rota será possível enviar o cadastro de uma ou mais pessoas, os limites de crédito de uma ou mais pessoas (ou ambos) para inclusão/atualização na base do Qgestora.
Atualmente a importação só está disponível para pessoas do tipo Cedente.

Parâmetros#

AtributoTipoObrigTamOcorrDescrição
tokenAlfaSim641:1Token gerado no Qgestora
pessoas1:NEstrutura do cadastro de pessoas
tipoEntidadeAlfaSim11:1Tipo de entidade (ver tabela Tipo Entidade)
tipoPessoaAlfaNão10:1Tipo de pessoa (ver tabela Tipo Pessoa)
cnpjCpfAlfaSim181:1CPF ou CNPJ da pessoa, com ou sem máscara
nomeAlfaSim2551:1Nome (se PF) ou Razão social (se PJ)
nomeFantasiaAlfaNão600:1Nome fantasia (se PJ) ou Apelido (se PF). Se não for informado, será preenchido com o Nome.
inscricaoEstadualAlfaNão250:1Inscrição Estadual (se PJ)
isentoIEAlfaNão10:1Isento de Inscrição Estadual (S/N)
inscricaoMunicipalAlfaNão250:1Inscrição Municipal (se PJ)
cnaeAlfaNão100:1Código da atividade econômica principal, com ou sem máscara (se PJ)
siteAlfaNão2550:1Website da empresa (se PJ)
numFuncionariosNumNão100:1Número de funcionários (se PJ)
recuperacaoJudicialAlfaNão10:1Recuperação judicial (S/N) (se PJ)
processoFalenciaAlfaNão10:1Processo de falência (S/N) (se PJ)
instituicaoFinanceiraAlfaNão10:1Instituição Financeira (S/N) (se PJ)
docIdentidadeAlfaNão250:1Número do RG (se PF)
orgaoExpedidorAlfaNão100:1Órgão emissor do RG (se PF)
dataExpedicaoDataNão0:1Data de emissão do RG (se PF)
estadoCivilNumNão20:1Estado civil (ver tabela Estado Civil) (se PF)
regimeCasamentoNumNão20:1Regime de casamento (ver tabela Regime Casamento) (se PF)
emailAlfaNão2550:1E-mail
dddTelefone1NumNão30:1DDD do telefone 1
numTelefone1NumNão90:1Número do telefone 1
dddTelefone2NumNão30:1DDD do telefone 2
numTelefone2NumNão90:1Número do telefone 2
cepAlfaNão90:1Código de endereçamento postal, com ou sem máscara
enderecoAlfaNão2550:1Descrição do logradouro
numEnderecoNumNão60:1Número do endereço
compEnderecoAlfaNão750:1Complemento do endereço
bairroAlfaNão750:1Bairro
cidadeAlfaNão500:1Cidade
ufAlfaNão20:1Estado (UF)
limitesNão0:NEstrutura do limite de crédito da pessoa
cnpjFundoAlfaSim181:1CNPJ do Fundo (FIDC), com ou sem máscara. Retorna erro se o CNPJ for inválido ou o fundo não for encontrado.
valorLimiteCreditoNumCond.17,20:1Valor do limite de crédito. Pelo menos um entre valorLimiteCredito e percLimiteCredito deve ser informado e maior que zero. Retorna erro se o formato for inválido.
percLimiteCreditoNumCond.5,20:1Percentual do limite de crédito (máx. 100). Pelo menos um entre valorLimiteCredito e percLimiteCredito deve ser informado e maior que zero. Retorna erro se o formato for inválido.
dataInicioVigenciaDataSim1:1Data de início da vigência do limite de crédito. Deve ser maior ou igual à data atual.
dataFimVigenciaDataNão0:1Data do fim da vigência do limite de crédito. Se informada, deve ser maior que dataInicioVigencia.

Tipo Entidade#

CódigoDescrição
CCedente
SSacado

Tipo Pessoa#

CódigoDescrição
FFísica
JJurídica

Estado Civil#

CódigoDescrição
1Casado (a)
2Separado (a)
3Solteiro (a)
4Viúvo (a)
5Divorciado (a)
6Desquitado (a)
7União Estável

Regime Casamento#

CódigoDescrição
1Comunhão Parcial de Bens
2Comunhão Universal de Bens
3Separação Total de Bens

Status Importação Pessoa#

CódigoDescrição
01Pessoa atualizada com sucesso.
02Pessoa atualizada com ressalvas.
03Pessoa não atualizada.
04Limite(s) de crédito atualizado(s) com sucesso.
05Limite(s) de crédito atualizado(s) com ressalvas.
06Limite(s) de crédito não atualizado(s).
07Pessoa e limite(s) de crédito atualizados com sucesso.
08Pessoa e limite(s) de crédito atualizados com ressalvas.
09Pessoa não atualizada. Limite(s) de crédito atualizado(s).
10Pessoa atualizada. Limite(s) de crédito não atualizado(s).
11Pessoa atualizada com ressalvas. Limite(s) de crédito não atualizado(s).
12Pessoa e limite(s) de crédito não atualizados.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Sucesso. Retorna validações ou mensagem de lista vazia.

Mensagens de Validação dos Limites

As mensagens de validação dos limites são retornadas no HTTP 200 dentro do array mensagens de cada pessoa, com tipo ERRO ou ALERTA.
TipoMensagemSituação
ERRO[Limite]: Fundo com CNPJ: {cnpj} não foi encontrado.cnpjFundo não cadastrado no sistema
ERRO[Limite]: CNPJ informado para o fundo: {cnpj}, é inválido.cnpjFundo com formato inválido
ERRO[Limite]: Fundo CNPJ: {cnpj}. "{campo}" possui caracteres inválidos ou excede o tamanho máximo.Formato inválido em valorLimiteCredito ou percLimiteCredito
ERRO[Limite]: Limite de crédito não informado para o fundo CNPJ: {cnpj}.valorLimiteCredito e percLimiteCredito ambos ausentes ou zero
ERRO[Limite]: ... Data Início Vigência é um campo obrigatório.dataInicioVigencia não informada
ERRO[Limite]: ... Data Início Vigência deve ser maior ou igual à Data Atual.dataInicioVigencia anterior à data atual
ERRO[Limite]: ... Data Fim Vigência deve ser maior que a Data Início Vigência.dataFimVigencia anterior à dataInicioVigencia
ALERTA[Limite]: ... O limite importado irá sobrepor o(s) limite(s) ativo(s) existente(s).Já existe limite ativo para o fundo — será substituído
Bodyapplication/json

🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/import-person-limit' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "###############################################",
    "pessoas": [
        {
            "tipoEntidade": "C",
            "tipoPessoa": "J",
            "cnpjCpf": "99999999999999",
            "nome": "NOME/RAZAO SOCIAL",
            "nomeFantasia": "NOME FANTASIA",
            "inscricaoEstadual": "",
            "isentoIE": "S",
            "inscricaoMunicipal": "",
            "cnae": "9999-9/99",
            "site": "",
            "numFuncionarios": 999999,
            "recuperacaoJudicial": "N",
            "processoFalencia": "N",
            "docIdentidade": "",
            "orgaoExpedidor": "",
            "dataExpedicao": "01/01/1900",
            "estadoCivil": 0,
            "regimeCasamento": 0,
            "email": "pessoa@email.com.br",
            "dddTelefone1": 99,
            "numTelefone1": 999999999,
            "dddTelefone2": 99,
            "numTelefone2": 999999999,
            "cep": "99999-999",
            "endereco": "DESCRICAO LOGRADOURO",
            "numEndereco": 0,
            "compEndereco": "",
            "bairro": "NOME BAIRRO",
            "cidade": "NOME CIDADE",
            "uf": "SP",
            "limites": [
                {
                    "cnpjFundo": "99999999999999",
                    "valorLimiteCredito": 999999999.99,
                    "percLimiteCredito": 0,
                    "dataInicioVigencia": "01/01/2024",
                    "dataFimVigencia": "31/12/2024"
                }
            ]
        }
    ]
}'
Response Response Example
200 - response
[
    {
        "tipoPessoa": "J",
        "cnpjCpf": "99999999999999",
        "status": 1,
        "descricao": "Pessoa atualizada com sucesso.",
        "mensagens": []
    }
]
Modified at 2026-06-08 21:30:31
Next
Validar Importação de Operação
Built with