Deps Documentação

# Consulta dados

# Consulta cliente

A API consulta dados cliente está disponível para que seja possível a coleta de dados de um cliente específico na base do DepsNet. Através desta API é possível extrair a maior parte das informações disponíveis do cliente referentes a dados cadastrais, resultado da análise, limites, endereço, bloqueios, questionário, participações em empresas, quadro societário, métricas, informação cadastral e grupo econômico.

A API de consulta dados também é disponível em uma segunda versão, cujos códigos de retorno HTTP são 200 (Success) ou 204 (No content), diferente da versão original, cujos códigos de retorno são 200 (Success), 400 (Bad Request) ou 404 (Not Found).

A documentação de solicitação (Request) e layout de retorno são idênticos aos da versão original da API, vistos anteriormente.

# Layout de requisição

Esta API conta com a possibilidade da utilização de token, gerado através do Gerador de Token https://docs.deps.com.br/deps/integracao/rest/rest-token/ (opens new window), para validar as requisições. Para utilizar esta opção, o usuário deve acessar as configurações do Deps e definir a parametrização “Utilizar token nas APIs” como “Sim”. Os tokens gerados através do Gerador de Tokens possuem uma data de validade, que é definida através da parametrização do sistema “Tempo token válido”.

Para consultar a estrutura da API de Consulta dados deve ser acessado a URL http://localhost:74/swagger/ui/index#!/ConsultaDados/ConsultaDados_ConsultaDados (opens new window). E para consultar a estrutura da API de Consulta dados versão 2 deve ser acessado a URL http://localhost:74/swagger/ui/index#!/ConsultaDados/ConsultaDados_ConsultaDadosV2 (opens new window), onde "localhost" representa o nome do servidor em que está instalado a API. Ao acessar a URL pode ser visto a estrutura de exemplo do serviço, conforme imagem abaixo:

Imagem_resquisicao_rest

Segue abaixo documentação referente aos campos necessários para a solicitação (Request) de consumo da API:

Campo Descrição Tipo Tam. Obr.
[ {
tipo Tipo da pessoa, sendo:
J - Jurídica
F - Física
E - Exportação		 String 1 Sim
documento Documento da pessoa, sendo:
- CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15 Sim
nomeOrigem Nome da origem de informação cadastral String 40 Sim
token Token gerado via API do Deps String Não
opcoesDadosExtracao {
dadosCadastrais Campo que define se deve retornar os dados cadastrais do cliente Boolean N/A Não
resultadoAnalise Campo que define se deve retornar os dados da análise de crédito do cliente Boolean N/A Não
limiteAdotado Campo que define se deve retornar o limite adotado do cliente Boolean N/A Não
limiteTomado Campo que define se deve retornar o limite tomado do cliente Boolean N/A Não
endereco Campo que define se deve retornar os dados de endereço do cliente Boolean N/A Não
bloqueio Campo que define se deve retornar os dados de bloqueio do cliente Boolean N/A Não
questionario Campo que define se deve retornar os dados de questionário do cliente Boolean N/A Não
participacaoEmpresas Campo que define se deve retornar os dados de participações em empresas do cliente Boolean N/A Não
quadroSocietario Campo que define se deve retornar o quadro societário do cliente Boolean N/A Não
metricas Campo que define se deve retornar as métricas da análise do cliente Boolean N/A Não
percentuais Campo que define se deve retornar percentuais atingidos da política do cliente.
Essa informação será exibida no grupo de "resultadoAnalise"		 Boolean N/A Não
informacaoCadastral Campo que define se deve retornar a informação cadastral do cliente Boolean N/A Não
grupo Campo que define se deve retornar os dados do grupo econômico do cliente Boolean N/A Não
ultimasConsultas Campo que define a quantidade de consultas que devem ser retornadas.
O máximo são 10 consultas		 Int N/A Não
detalhamentoMetricas Campo que define se deve retornar os dados de detalhamento de métricas do cliente Boolean N/A Não
inscricoesEstaduais Campo que define se deve retornar dados referentes a inscrições estaduais do cliente Boolean N/A Não
inscricoesSuframa Campo que define se deve retornar dados referentes a inscrições suframas do cliente Boolean N/A Não
ramosAtividade Campo que define se deve retornar dados referentes a ramos de atividade do cliente Boolean N/A Não
contatos Campo que define se deve retornar dados referentes a contatos do cliente Boolean N/A Não
dadosProfissionais Campo que define se deve retornar dados referentes a dados profissionais do cliente Boolean N/A Não
perfilEspecial Campo que define se deve retornar dados referentes aos perfis especiais do cliente Boolean N/A Não
limites Campo que define se deve retornar dados referentes aos limites do cliente Boolean N/A Não
Exemplo layout JSON 
{
  "tipo": "J",
  "documento": "12345678900000",
  "nomeOrigem": "Nome Pessoa",
  "opcoesDadosExtracao": {
    "dadosCadastrais": true,
    "resultadoAnalise": true,
    "limiteAdotado": true,
    "limiteTomado": true,
    "endereco": true,
    "bloqueio": true,
    "questionario": true,
    "participacaoEmpresas": true,
    "quadroSocietario": true,
    "metricas": true,
    "percentuais": true,
    "informacaoCadastral": true,
    "grupo": true,
    "ultimasConsultas": 0,
    "detalhamentoMetricas": true,
    "inscricoesEstaduais": true,
    "inscricoesSuframa": true,
    "ramosAtividade": true,
    "contatos": true,
    "dadosProfissionais": true,
    "perfilEspecial": true,
    "limites": true
  }
}

# Layout de retorno

Segue abaixo os campos retornados ao consultar os dados do cliente, de acordo com as opções solicitadas:

Campo Descrição Tipo Tam.
dadosCadastrais: {
codigoSistemaGestao Código identificador da pessoa no Sistema de Gestão String 50
documento Documento da pessoa, sendo:
- CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15
razaoSocial Razão social quando tipo pessoa for "J". Caso contrário retornará null String 200
nome Nome da pessoa, sendo:
- Nome fantasia quando tipo pessoa for "J"
- Nome da pessoa quando tipo pessoa for "F"
- Nome identificador quando tipo pessoa for "E"		 String 200
fundacao Data de fundação quando tipo pessoa for "J", e data de nascimento quando tipo pessoa for "F".
Caso contrário retornará null.
Formato: dd/MM/aaaa		 String 10
clienteDesde Data de cadastro do cliente na organização.
Formato: dd/MM/aaaa		 String 10
origem Nome da origem do cliente String 40
pais País do cliente quando o tipo pessoa for "E".
Caso contrário retornará null		 String 50
inscricaoEstadual Número da inscrição estadual do cliente String 15
situacaoCadastralInscricaoEstadual Situação cadastral da inscrição estadual do cliente no Sintegra String 100
capitalSocial Valor do capital social do cliente Decimal 18,2
naturezaJuridica Natureza jurídica do cliente String 200
situacaoCadastralCNPJ Situação cadastral do cliente na Receita Federal String 100
porte Porte do cliente String 200
regimeTributario Regime tributário do cliente String 100
nomeMae Nome da mãe String 200
cpfMae CPF da mãe String 11
sexo Sexo da pessoa
"M" - Masculino
"F" - Feminino		 String 1
opcaoSimples Opção Simples Nacional String 100
dataOpcaoSimples Data da opção Simples Nacional.
Formato: dd/MM/aaaa		 String 10
dataExclusaoSimples Data da exclusão da opção Simples Nacional.
Formato: dd/MM/aaaa		 String 10
opcaoMei Opção MEI Simples Nacional String 100
contribuinteICMS Define se cliente é contribuinte ICMS String 3
tipoFaturamento Define o tipo de faturamento do cliente String 50
codigoColigado Código do coligado no sistema de gestão String 100
nomeColigado Nome do coligado no sistema de gestão String 300
enderecos: { endereco: [ {
origem Nome da origem do endereço String 40
rua Nome da rua String 200
numero Número do logradouro String 10
bairro Nome do bairro String 100
cep Código de endereço postal do logradouro String 10
cidade Nome da cidade String 40
ibge Código do IBGE da cidade Int
uf Unidade federativa do endereço do cliente.
Caso o tipo pessoa for "E", poderá ser retornado EX		 String 2
complemento Complemento do logradouro String 80
apelido Apelido do endereço String 200
tipoEndereco Tipo do endereço String 100
confirmado Se o endereço está confirmado Boolean
contatos: [ {
origem Nome da origem do contato String 40
nome Nome do contato String 200
cargo Nome do cargo do contato String 100
telefone Número de telefone String 25
celular Número de celular String 25
email Endereço de E-mail String 200
preferencial Define se contato é preferencial
- Sim
- Não		 String 3
observacao Comentário relacionado ao contato String 250
ativo Define se contato está ativo
- Sim
- Não		 String 3
resultadoAnalise: {
politica Nome da política que o cliente se encontra na origem consultada String 40
classificação Nome da classificação que o cliente se encontra String 40
dataValidadeAnalise Data da validade da análise atual do cliente.
Formato: dd/mm/aaaa		 String 10
limiteDataUltimaInclusao Data da última inclusão do limite no cliente.
Formato: dd/mm/aaaa hh:mm:ss		 String 10
limiteSugerido Valor do limite sugerido atual do cliente Decimal 18,2
limiteAdotado Valor do limite adotado atual do cliente Decimal 24,6
limiteAdotadoPerfilEspecial Valor do limite perfil especial adotado atual do cliente.
Obs: Somente informado caso seja solicitado a informação de limite adotado. Caso não solicitado, será retornado valor padrão 0,00.
Obs: Será retornado o limite do perfil especial, que atenda os requisitos de estar dentro da validade e não for do tipo critério ou aprova tudo. Caso não atendam a regra e o cliente possuir grupo econômico com limite perfil especial, atendendo os mesmos requisitos, será informado o limite especial do grupo econômico, se possuir mais de um limite de perfil especial, os valores do limite serão somados, tanto para o cliente quanto para o grupo econômico.		 Decimal 24,6
risco Nome do risco atual do cliente String 40
limiteTomado Valor do limite tomado atual do cliente Decimal 18,2
limiteDisponivel Valor do limite disponível atual do cliente.
Obs: Somente informado caso seja solicitado ambas informações de limite adotado e limite tomado. Caso não solicitado ambas, será retornado valor padrão 0,00.
Obs: Campo pode ser calculado utilizando perfil especial do cliente, para isso deve ser utilizado a parametrização de sistema 'Utilizar perfil especial na api consulta dados'		 Decimal 18,2
percentualPositivo Percentual positivo Decimal 18,2
percentualNegativo Percentual negativo Decimal 18,2
percentualAtingido Percentual atingido Decimal 18,2
quantidadeTitulosVencidos Quantidade de títulos vencidos Integer
dataDeVencimentoDoTituloMaisAntigo Data de vencimento do título mais antigo.
Formato: dd/mm/aaaa		 String 10
valorTotalTitulosVencidos Valor total de títulos vencidos Decimal 18,2
resultadoAnalise: { metricasPositivas: [ {
descricao Descrição da métrica positiva String 40
complemento Complemento da métrica positiva String 100
pontos Pontos positivos da métrica Decimal 18,2
percentualImpacto Percentual impacto atingido Decimal 18,2
impactoPolitica Percentual impacto na política atingido Decimal 18,2
resultadoAnalise: { metricasNegativas: [ {
descricao Descrição da métrica negativa String 40
complemento Complemento da métrica negativa String 100
pontos Pontos negativos da métrica Decimal 18,2
percentualImpacto Percentual impacto atingido Decimal 18,2
impactoPolitica Percentual impacto na política atingido Decimal 18,2
resultadoAnalise: { perfilEspecial: [ {
perfilEspecialDocumento: [ {
valorLimite Valor do limite do perfil especial Decimal 18,2
valorLimiteDisponivel Valor do limite disponível Decimal 18,2
tipoValidacao Tipo de validação (Critério, Perfil especial, Aprova tudo) String 40
processoPadrao Define se o perfil é processo padrão (Sim,Não) String 10
validaAlcada Define se o perfil valida alçada (Sim,Não) String 10
dataValidade Data de validade do perfil String 10
risco Risco do perfil calculado em tempo real String 40
nome Nome do perfil especial String 30
origem Nome da origem do perfil especial String 40
perfilEspecialDocumento: [ { criterios: [ {
criterio Nome do critério String 40
valorCriterio Valor do critério Decimal 18,2
percentualAumentoCriterio Percentual de aumento do critério Decimal 18,2
perfilEspecialGrupo: [ {
valorLimite Valor do limite do perfil especial Decimal 18,2
valorLimiteDisponivel Valor do limite disponível Decimal 18,2
tipoValidacao Tipo de validação (Critério, Perfil especial, Aprova tudo) String 40
processoPadrao Define se o perfil é processo padrão (Sim,Não) String 10
validaAlcada Define se o perfil valida alçada (Sim,Não) String 10
dataValidade Data de validade do perfil String 10
risco Risco do perfil calculado em tempo real String 40
nome Nome do perfil especial String 30
origem Nome da origem do perfil especial String 40
perfilEspecialGrupo: [ { criterios: [ {
criterio Nome do critério String 40
valorCriterio Valor do critério Decimal 18,2
percentualAumentoCriterio Percentual de aumento do critério Decimal 18,2
bloqueios: {
totalBloqueios Total de bloqueios do cliente/grupo na origem consultada Int
bloqueios: { bloqueio: [ {
documento Documento do bloqueio String 15
origemBloqueio Nome da origem do bloqueio String 40
codigoBloqueio Código do bloqueio String 10
descricao Descrição do bloquei String 60
dataBloqueio Data e hora do bloqueio.
Formato: dd/mm/aaaa hh:mm:ss		 String 20
tipoValidacao Descrição do tipo de validação do bloqueio String 20
ativo Define se o bloqueio está ativo ou não Boolean
questionario: {
totalPerguntasRespondidas Total de perguntas respondidas do cliente/grupo Integer
questionario: { questoes: [ {
documento Documento da questão String 15
pergunta Descrição da questão String 300
resposta Descrição da resposta String 100
validade Validade da questão Formato: dd/mm/aaaa String 10
informacaoCadastral: {
totalInformacoesCadastrais Total de informações cadastrais do cliente/grupo Integer
informacaoCadastral: { informacao: [ {
documento Documento da informação cadastral String 15
nomeOrigem Descrição da origem da questão String 40
grupo Descrição do grupo da informação cadastral String 40
subGrupo Descrição do subgrupo da informação cadastral String 40
codigoSistemaGestao Código da informação cadastral String 50
descricao Descrição da informação cadastral String 200
tipo Tipo da informação cadastral String 15
quadroSocietario: {
totalSocios Quantidade total de sócios do cliente/grupo Integer
quadroSocietario: { socio : [ {
documento Documento que sócio está associado String 14
documentoSocio Documento do sócio, cpf ou cnpj String 14
tipo Tipo do sócio,
"J" para pessoa jurídica
ou "F" para pessoa física		 String 1
nome Nome do sócio String 200
participacao Percentual de participação do sócio Decimal 10,2
entrada Data de entrada do sócio. Formato: dd/mm/aaaa String 10
saida Data de saída do sócio. Formato: dd/mm/aaaa String 10
restricao Define se o sócio possui ou não restrição Boolean
participacaoEmpresa: {
totalParticipacoes Quantidade total de participações em outras empresas Integer
participacaoEmpresa: { participacao : [ {
documento Documento do cliente/grupo String 14
documentoParticipada Documento da participada String 14
nomeParticipada Nome da participada String 200
documentoParticipante Documento do participante String 14
dataEntrada Data de entrada na participação. Formato: dd/mm/aaaa String 10
capital Capital de participação Decimal 18,2
percentual Percentual de participação Decimal 18,2
cidade Nome da cidade String 40
uf Unidade federativa String 2
restricao Define se a participada possui restrição Boolean
grupo: {
totalComponentes Total de componentes no grupo Integer
nomeGrupo Nome do grupo String 40
codigoGrupo Codigo do grupo String 50
grupo: { componentes: [ {
documento Documento do componente do grupo String 15
nome Nome do componente String 200
consultas: [ {
provedor Provedor da consulta String 15
codigoTipoConsulta Tipo da consulta String 200
consulta String da consulta.
Obs.: A string da consulta pode ser retornada com formatação(HTML) para visualização no sistema DepsNet, ou ser retornada a string original vinda do provedor.
Por padrão é retornada a string formatada, podendo ser alterado pela parametrização de sistema 'Formato da consulta na API Consulta Dados'.		 String Text
data Data e hora da consulta realizada no DepsNet.Formato:
dd/mm/aaaa HH:mm:ss		 String
usuario Usuário que realizou a consulta no DepsNet String 40
detalhamentoMetricas: {
detalhamentoMetricas: { balanco: { balancos: [ {
documento Documento do balanço String 15
anoExercicioAnterior Ano do exercício anterior Integer
anoExercicioAtual Ano do exercício atual Integer
detalhamentoMetricas: { balanco: { balancos: [ { itensBalanco: [ {
descricao Descrição do item do balanço String 100
exercicioAnterior Exercício anterior Decimal 18,2
exercicioAtual Exercício atual Decimal 18,2
detalhamentoMetricas: { balanco: { balancos: [ { indicadores: [ {
descricao Descrição do indicador String 100
exercicioAnterior Exercício anterior Decimal 18,2
exercicioAtual Exercício atual Decimal 18,2
comparacao Comparação do indicador Decimal 18,2
detalhamentoMetricas: { ccf: [ {
nome Nome que consta no cheque String 200
dataUltimo Data último cheque Formato: dd/mm/aaaa String 23
quantidade Quantidade Integer
detalhamentoMetricas: { contasReceber: {
titulosPagos Títulos pagos Decimal 18,2
titulosVencidos Títulos vencidos Decimal 18,2
titulosAVencer Títulos a vencer Decimal 18,2
chequesPagos Cheques pagos Decimal 18,2
chequesVencidos Cheques vencidos Decimal 18,2
chequesAVencer Cheques a vencer Decimal 18,2
notasCredito Notas credito Decimal 18,2
notasDebito Notas debito Decimal 18,2
atrasoMatriz Atraso matriz Decimal 18,2
prazoMedio Prazo médio Decimal 18,2
maiorAcumulo Maior acúmulo Decimal 18,2
dataAcumulo Data acúmulo Formato: dd/mm/aaaa String 23
maiorCompra Maior compra Decimal 18,2
dataMaiorCompra Data maior compra Formato: dd/mm/aaaa String 23
ultimaCompra Última compra Decimal 18,2
dataUltimaCompra Data última compraFormato: dd/mm/aaaa String 23
detalhamentoMetricas: { contasReceberAnalitico: [ {
periodo Período String 7
valor Valor Decimal 18,2
liquidez Liquidez Decimal 18,2
recompra Recompra Decimal 18,2
detalhamentoMetricas: { fornecedoresAtivos: [ {
nome Nome String 200
dataConsulta Data consulta Formato: dd/mm/aaaa String 23
quantidadeTotal Quantidade total Integer
periodo0a6Meses Período de 0 a 6 meses Integer
periodo7a12Meses Período de 7 a 12 meses Integer
periodo1a2Anos Período de 1 a 2 anos Integer
periodo3a5Anos Período de 3 a 5 anos Integer
periodo6a10Anos Período de 6 a 10 anos Integer
mais10Anos Mais de 10 anos Integer
detalhamentoMetricas: { fundacao: [ {
nome Nome String 200
dataFundacao Data fundação Formato: dd/mm/aaaa String 23
idadeMeses Idade em meses Integer
idadeAnos Idade em anos Integer
detalhamentoMetricas: { historicoPagamentos: [ {
periodo Período String 7
valor Valor Decimal 18,2
aVista À vista Decimal 18,2
pontual Pontual Decimal 18,2
dias6a15 Dias 6 a 15 Decimal 18,2
dias16a30 Dias 16 a 30 Decimal 18,2
dias31a60 Dias 31 a 60 Decimal 18,2
mais60 Mais de 60 Decimal 18,2
media Média Decimal 18,2
detalhamentoMetricas: { oscilacoesConsulta: {
detalhamentoMetricas: { oscilacoesConsulta: { oscilacaoConsulta: [ {
nome Nome String 200
periodo Período String 7
quantidade Quantidade Integer
detalhamentoMetricas: { oscilacoesConsulta: { ultimosConsultantes: [ {
documento Documento String 15
nome Nome String 200
quantidade Quantidade Integer
detalhamentoMetricas: { pefin: [ {
nome Nome String 200
quantidadeTotal Quantidade total Integer
valorTotal Valor total Decimal 18,2
dataUltimo Data últimoFormato: dd/mm/aaaa String 23
detalhamentoMetricas: { porte: [ {
nome Nome String 200
valorTotal Valor total Decimal 18,2
aVista À vista Decimal 18,2
pontual Pontual Decimal 18,2
dias6a15 Dias 6 a 15 Decimal 18,2
dias16a30 Dias 16 a 30 Decimal 18,2
dias31a60 Dias 31 a 60 Decimal 18,2
mais60 Mais de 60 Decimal 18,2
media Média Decimal 18,2
detalhamentoMetricas: { protesto: [ {
nome Nome String 200
data DataFormato: dd/mm/aaaa String 23
quantidade Quantidade Integer
valor Valor Decimal 18,2
detalhamentoMetricas: { rating: [ {
documento Documento String 15
nome Nome String 200
conceito Conceito String 10
dataCadastro Data cadastro String 23
tipoConsulta Tipo consulta String 30
provedor Provedor String 15
detalhamentoMetricas: { refin: [ {
nome Nome String 200
data DataFormato: dd/mm/aaaa String 23
quantidade Quantidade Integer
valor Valor Decimal 18,2
detalhamentoMetricas: { scoring: [ {
documento Documento String 15
nome Nome String 200
conceito Conceito String 10
dataCadastro Data cadastroFormato: dd/mm/aaaa String 23
tipoConsulta Tipo consulta String 30
provedor Provedor String 15
inscricoesEstaduais: {
totalInscricoesEstaduais Total de inscrições estaduais vinculadas ao documento Integer
inscricoesEstaduais: [ {
origem Nome da origem do cliente String 40
inscricaoEstadual Inscrição estadual String 15
situacao Situação da inscrição estadual String 50
dataSituacao Data da situaçãoFormato: dd/mm/aaaa String
status Status da inscrição estadual
- Inativo
- Ativo
- Sem informação
- Isento		 String
dataAtualizacao Data da ultima atualização das informaçõesFormato: dd/mm/aaaa String
inscricoesSuframa: {
totalInscricoesSuframa Total de inscrições suframas vinculadas ao documento Integer
inscricoesSuframa: [ {
origem Nome da origem do cliente String 40
inscricaoSuframa Inscrição suframa String 15
situacao Situação da inscrição suframa String 50
status Status da inscrição suframa
- Inativa
- Ativa
- Cancelada
- Bloqueada
- Habilitada
- Não habilitada		 String
dataAtualizacao Data da ultima atualização das informaçõesFormato: dd/mm/aaaa String
tipoIncentivo Tipo de incentivo da inscrição suframa String
ramosAtividade: { Verificar Detalhe
totalRamosAtividade Total de ramos de atividade vinculadas ao documento Integer
ramosAtividade: [ {
codigo Código do ramo atividade String
descricao Descrição do ramo atividade String
tipo Tipo do ramo de atividade
- Principal
- Secundário		 String
dadosProfissionais: [ {
tipoRegistro Tipo do registro profissional
- CRO
- CRMV
- ANVISA		 String 30
uf Uf do registro profissional String 2
areaAtuacao Área de atuação do registro profissional String 200
codigoAreaAtuacao Código do sistema de gestão da área de atuação do registro profissional String
numero Número do registro profissional String 30
ativo Define se registro profissional está ativo
- Sim
- Não		 String 3
limites: {
limites: { limiteGrupo: {
grupo Nome do grupo String 40
origem Nome da origem do grupo String 40
valor Valor do limite adotado atual do grupo Decimal 24,6
necessario Valor do limite necessário atual do grupo Decimal 18,2
tomado Valor do limite tomado atual do grupo Decimal 18,2
disponivel Valor do limite disponível atual do grupo Decimal 18,2
classificacao Nome da classificação que o grupo se encontra String 40
risco Nome do risco atual do grupo String 40
limites: { limiteGrupo: { divisores: [ {
divisorLimite Nome do divisor de limite String 50
valor Valor do limite adotado no divisor Decimal 24,6
necessario Valor do limite necessário no divisor Decimal 18,2
tomado Valor do limite tomado no divisor Decimal 18,2
disponivel Valor do limite disponível atual do grupo Decimal 18,2
limites: { limiteDocumentos: [ {
documento Documento da pessoa, sendo:
- Raiz quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15
origem Nome da origem do cliente String 40
valor Valor do limite adotado atual do cliente Decimal 24,6
necessario Valor do limite necessário atual do cliente Decimal 18,2
tomado Valor do limite tomado atual do cliente Decimal 18,2
disponivel Valor do limite disponível atual do cliente Decimal 18,2
classificacao Nome da classificação que o cliente se encontra String 40
risco Nome do risco atual do cliente String 40
bloqueio Informa se o cliente possui bloqueio String 10
limites: { limiteDocumentos: [ { divisores: [ {
divisorLimite Nome do divisor de limite String 50
valor Valor do limite adotado no divisor Decimal 24,6
necessario Valor do limite necessário no divisor Decimal 18,2
tomado Valor do limite tomado no divisor Decimal 18,2
disponivel Valor do limite disponível atual do grupo Decimal 18,2
limites: { limiteDocumentos: [ { limitePessoas: [ {
documento Documento da pessoa String 15
origem Nome da origem da pessoa String 40
valor Valor do limite adotado atual da pessoa Decimal 24,6
necessario Valor do limite necessário atual da pessoa Decimal 18,2
tomado Valor do limite tomado atual da pessoa Decimal 18,2
disponivel Valor do limite disponível atual da pessoa Decimal 18,2
classificacao Nome da classificação que a pessoa se encontra String 40
limites: { limiteDocumentos: [ { limitePessoas: [ { divisores: [ {
divisorLimite Nome do divisor de limite String 50
valor Valor do limite adotado no divisor Decimal 24,6
necessario Valor do limite necessário no divisor Decimal 18,2
tomado Valor do limite tomado no divisor Decimal 18,2
disponivel Valor do limite disponível atual do grupo Decimal 18,2

Detalhes

# Utilizar perfil especial na API consulta dados:

Parametrização de sistema 'Utilizar perfil especial na API consulta dados' é utilizada para definir o método de cálculo do limite disponível. Caso parâmetro estiver ativo, sistema tentará utilizar o limite do perfil especial do cliente no cálculo do limite disponível, substituindo o valor do limite adotado do cliente.
Somente perfis especiais de tipo limite e dentro da data de validade são considerados.
Caso cliente possuir mais de um perfil especial, os valores serão somados entre os perfis validos.
Caso todos os perfis validos estiverem configurados com 'Seguir Processo Padrão' igual a 'Sim', será feito comparação entre o valor somado entre os perfis, e o limite adotado atual do cliente, e o sistema utilizará o maior valor. Se cliente possuir ao menos um perfil valido neste processo, que não siga o processo padrão, comparação não será feita, e sistema utilizará o valor dos perfis.
Quando cliente possuir grupo econômico, sistema tentará utilizar primeiramente o perfil especial do cliente, caso não possua nenhum valido, irá tentar utilizar o do grupo econômico, caso não possuir perfil especial valido no grupo, será utilizado o valor de limite adotado padrão para o grupo econômico.

# Dados do ramo de atividade:

As informações sobre o ramo de atividade do cliente são extraídas durante a execução da requisição, da consulta mais recente entre as três opções a seguir:

  • Receita PJ;
  • Mix PJ Analítica;
  • Mix PJ Não Analítica.

# Consulta situação pedido

# Layout de requisição

Esta API conta com a possibilidade da utilização de token, gerado através do Gerador de Token https://docs.deps.com.br/deps/integracao/rest/rest-token/ (opens new window), para validar as requisições. Para utilizar esta opção, o usuário deve acessar as configurações do Deps e definir a parametrização “Utilizar token nas APIs” como “Sim”. Os tokens gerados através do Gerador de Tokens possuem uma data de validade, que é definida através da parametrização do sistema “Tempo token válido”.

Para consultar a estrutura da API de Consulta dados situação pedido deve ser acessado a URL http://localhost:74/swagger/ui/index#!/ConsultaDados/ConsultaDados_ConsultaDadosSituacaoPedido (opens new window), onde “localhost” representa o nome do servidor que está instalado a API. Ao acessar a URL pode ser visto a estrutura de exemplo do serviço, conforme imagem abaixo:

Imagem_resquisicao_rest_pedido

Segue abaixo documentação referente aos campos necessários para a solicitação (Request) de consumo da API:

Campo Descrição Tipo Tam. Obr.
[{
codigoPedido Código do pedido a ser consultado. String 30 Sim
token Token gerado via API do Deps String Não
}]
Exemplo layout JSON 
[
  {
    "codigoPedido": "CodigoPedido03"
  }
]

# Layout de retorno

Segue abaixo os campos retornados ao consultar os dados de pedido:

Campo Descrição Tipo Tam.
[{
statusRetorno Status referente ao retorno da consulta.
“OK” para consulta realizada. Em caso de problemas, “Erro:” seguido da descrição do problema.		 String
codigoPedido Código do pedido que foi consultado. String 30
descricaoSituacao Informação da situação do pedido. String 50
sistemaGestaoSituacao Sistema de gestão da situação. String 50
dataSituacao Data de cadastro da situação. Datetime
ultimoParecer Ultimo parecer do pedido. String 200
usuario Usuário relacionado a situação do pedido. String 200
[{
sistemaGestao Sistema de gestão do motivo. String 50
nome Descrição do motivo. String 50
}]
}]

# Consulta listar negociações

# Layout de requisição

Esta API conta com a possibilidade da utilização de token, gerado através do Gerador de Token https://docs.deps.com.br/deps/integracao/rest/rest-token/ (opens new window), para validar as requisições. Para utilizar esta opção, o usuário deve acessar as configurações do Deps e definir a parametrização “Utilizar token nas APIs” como “Sim”. Os tokens gerados através do Gerador de Tokens possuem uma data de validade, que é definida através da parametrização do sistema “Tempo token válido”.

Para consultar a estrutura da API de Consulta dados listar negociações deve ser acessado a URL http://localhost:74/swagger/ui/index#!/ConsultaDados/ConsultaDados_ConsultaDadosListarNegociacoes (opens new window), onde “localhost” representa o nome do servidor que está instalado a API. Ao acessar a URL pode ser visto a estrutura de exemplo do serviço, conforme imagem abaixo:

Imagem_resquisicao_rest_listar_negociacoes

Segue abaixo documentação referente aos campos necessários para a solicitação (Request) de consumo da API:

*A solicitação pode ser realizada das seguintes formas: "cód. sistema de gestão + origem" ou "documento + tipo + origem"

Campo Descrição Tipo Tam. Obr.
[{
tipo Tipo da pessoa, sendo:
J - Jurídica
F - Física
E - Exportação		 String 1 Sim*
documento Documento da pessoa, sendo:
- CNPJ quando for pessoa jurídica
- Raiz do CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15 Sim*
codigoSistemaGestaoCliente Código do cliente no sistema de gestão String 50 Sim*
nomeOrigem Nome da origem de informação cadastral String 40 Sim*
token Token gerado via API do Deps String Não
}]
Exemplo layout JSON 
[
  {
    "tipo": "J",
    "documento": "12345678000100",
    "codigoSistemaGestaoCliente": "ABC123",
    "nomeOrigem": "Sistema de Gestão"
  }
]

# Layout de retorno

Segue abaixo os campos retornados ao consultar a lista de negociações:

Campo Descrição Tipo Tam.
[{
negociacoes: [{
codigoSistemaGestaoCliente Código do cliente no sistema de gestão String 50
documentoCliente Documento do cliente String 15
codigoNegociacao Código da negociação. Int
dataNegociacao Data da negociação. Datetime
usuario Usuário que realizou a negociação. String 40
contatado Nome do contato. String 200
tipoNegociacao Tipo da negociação realizada. String 200
situacao Situação da negociação. String 200
validade Data de validade da negociação. Formato: dd/MM/yyyy String 10
}]
}]

# Consulta detalhamento negociação

# Layout de requisição

Esta API conta com a possibilidade da utilização de token, gerado através do Gerador de Token https://docs.deps.com.br/deps/integracao/rest/rest-token/ (opens new window), para validar as requisições. Para utilizar esta opção, o usuário deve acessar as configurações do Deps e definir a parametrização “Utilizar token nas APIs” como “Sim”. Os tokens gerados através do Gerador de Tokens possuem uma data de validade, que é definida através da parametrização do sistema “Tempo token válido”.

Para consultar a estrutura da API de Consulta dados detalhamento negociação deve ser acessado a URL http://localhost:74/swagger/ui/index#!/ConsultaDados/ConsultaDados_ConsultaDadosDetalhamentoNegociacao (opens new window), onde “localhost” representa o nome do servidor que está instalado a API. Ao acessar a URL pode ser visto a estrutura de exemplo do serviço, conforme imagem abaixo:

Imagem_resquisicao_rest_detalhamento_negociacao

Segue abaixo documentação referente aos campos necessários para a solicitação (Request) de consumo da API:

*A solicitação pode ser realizada das seguintes formas: "código negociação" ou ("cód. sistema de gestão + origem" ou "documento + tipo + origem")

Campo Descrição Tipo Tam. Obr.
[{
tipo Tipo da pessoa, sendo:
J - Jurídica
F - Física
E - Exportação		 String 1 Sim*
documento Documento da pessoa, sendo:
- CNPJ quando for pessoa jurídica
- Raiz do CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15 Sim*
codigoSistemaGestaoCliente Código do cliente no sistema de gestão String 50 Sim*
nomeOrigem Nome da origem de informação cadastral String 40 Sim*
codigoNegociacao Código da negociação Int Sim*
dataInicial Data inicial para buscar a negociação Datetime Não
dataFinal Data final para buscar a negociação Datetime Não
token Token gerado via API do Deps String Não
}]
Exemplo layout JSON 
[
  {
    "tipo": "string",
    "documento": "string",
    "codigoSistemaGestaoCliente": "ABC123",
    "nomeOrigem": "string",
    "codigoNegociacao": "string",
    "dataInicial": "string",
    "dataFinal": "string"
  }
]

# Layout de retorno

Segue abaixo os campos retornados ao consultar o detalhamento da negociação:

Campo Descrição Tipo Tam.
[{
detalhamentoNegociacoes: [{
codigoSistemaGestaoCliente Código do cliente no sistema de gestão String 50
documentoCliente Documento do cliente String 15
codigoNegociacao Código da negociação. Int
nomeTipoNegociacao Tipo da negociação. String 30
dataNegociacao Data da negociação. Datetime
nomeRecuperacaoSituacao Situação da negociação. String 30
dataValidade Data de validade da negociação. Formato: dd/MM/yyyy String 10
nomeUsuario Nome do usuário que realizou a negociação. String 50
nomeRecuperacaoCampanha Nome da campanha. String 30
nomeContato Nome do contato. String 200
emailContato Endereço de e-mail do contato. String 200
telefoneContato Telefone do contato. String 25
celularContato Celular do contato. String 25
observacao Observação da negociação. String
nomeTipoCalculoSaldo Tipo de cálculo do saldo. String 5
nomeTipoJurosSaldo Tipo de juros do saldo. String 8
multaAtrasoSaldo Multa atraso. Decimal 18,2
dataAtualizacaoSaldo Data até onde o saldo está atualizado. Formato: dd/MM/yyyy String 10
titulosSelecionadosSaldo Saldo dos títulos selecionados. Decimal 18,2
tipoTaxasJurosSaldo Tipo de taxa dos juros do saldo. String 2
taxasJurosSaldo Taxa dos juros do saldo. Decimal 18,2
tipoDespesasSaldo Tipo de despesas do saldo. String 2
despesasSaldo Despesas dos saldo. Decimal 18,2
valorAtualizacaoSaldo Saldo até a data de atualização do saldo. Decimal 18,2
valorFinanciamento Valor a ser financiado. Decimal 18,2
tipoEntradaFinancimento Tipo de entrada do financiamento. String 2
entradaFinanciamento Entrada do financiamento. Decimal 18,2
diasEntreParcelasFinanciamento Dias entre parcelas do financiamento. Int
nomeTipoAmortizacaoFinanciamento Tipo de amortização. String 13
tipoDescontoFinancimento Tipo de desconto do financiamento. String 2
descontoFinanciamento Desconto do financiamento. Decimal 18,2
dataPrimeiroVencimentoFinanciamento Data do primeiro vencimento do financiamento. Formato: dd/MM/yyyy String 10
tipoTaxaJurosFinanciamento Tipo de taxa dos juros do financiamento. String 2
taxaJurosFinanciamento Taxa dos juros do financiamento. Decimal 18,2
numeroParcelasFinanciamento Número de parcelas do financiamento. Int
nomeFormaPagamento Forma de pagamento do financiamento. String 30
observacoes: [{
nomeUsuario Nome do usuário que incluiu a observação. String 50
observacao Observação da negociação. String
dataNegociacao Data da negociação. Datetime
nomeTipoNegociacao Tipo da negociação. String 30
nomeRecuperacaoSituacao Situação da negociação. String 30
}]
titulos: [{
codigoSistemaGestaoCliente Código do cliente no sistema de gestão. String 50
documentoCliente Documento do cliente. String 15
codigoTitulo Código do título. String 30
documentoTitulo Documento do título. String 30
parcela Número da parcela. String 10
valor Valor do título. Decimal 18,2
valorSaldo Valor do saldo. Decimal 18,2
valorNegociado Valor negociado. Decimal 18,2
dias Dias entre a data de vencimento do título e a data atual. Int
emissao Data de emissão do título. Formato: dd/MM/yyyy String 10
vencimento Data de vencimento do título. Formato: dd/MM/yyyy String 10
vencimentoProrrogado Data de vencimento prorrogado do título. Formato: dd/MM/yyyy String 10
codigoRepresentante Codigo do representante no sistema de gestão. String 50
representante Nome do representante. String 200
cedente Nome do cedente. String 200
observacao Observação do título. String 150
observacao1 Observação 1 do título. String 150
observacao2 Observação 2 do título. String 150
observacao3 Observação 3 do título. String 150
categorias: [{
nome Nome da parametrização de categoria do título. String 100
codigoSistemaGestao Código da parametrização de categoria no sistema de gestão. String 100
}]
baixas: [{
dataPagamento Data de pagamento. Formato: dd/MM/yyyy String 10
valorPagamento Valor do pagamento. Decimal 18,2
nomeBaixa Nome da baixa. String 50
documentoBaixa Documento da baixa. String 50
}]
cobrancas: [{
dataRegistro Data do registro. Formato: dd/MM/yyyy HH:mm:ss String 19
tipoRegistro Descrição do tipo de registro. String 38
codigoTipoRegistro Código do tipo registro. String 1
usuario Nome do usuário. String 40
}]
}]
parcelasRefinancimento: [{
parcela Número da parcela. Int
dataVencimento Data de vencimento da parcela. Formato: dd/MM/yyyy String 10
amortizacao Amortização aplicada. Decimal 18,2
juros Juros aplicado. Decimal 18,2
valor Valor da parcela. Decimal 18,2
saldoDevedor Saldo devedor. Decimal 18,2
}]
}]
}]

# Consulta títulos negativação

# Layout de requisição

Esta API conta com a possibilidade da utilização de token, gerado através do Gerador de Token https://docs.deps.com.br/deps/integracao/rest/rest-token/ (opens new window), para validar as requisições. Para utilizar esta opção, o usuário deve acessar as configurações do Deps e definir a parametrização “Utilizar token nas APIs” como “Sim”. Os tokens gerados através do Gerador de Tokens possuem uma data de validade, que é definida através da parametrização do sistema “Tempo token válido”.

Para consultar a estrutura da API de Consulta dados títulos negativação deve ser acessado a URL http://localhost:74/swagger/ui/index#!/ConsultaDados/ConsultaDados_ConsultaDadosTituloNegativacao (opens new window), onde “localhost” representa o nome do servidor em que está instalado a API. Ao acessar a URL pode ser visto a estrutura de exemplo do serviço, conforme imagem abaixo:

Imagem_resquisicao_rest_titulo_negativacao

Segue abaixo documentação referente aos campos necessários para a solicitação (Request) de consumo da API:

Campo Descrição Tipo Tam. Obr.
{
provedor Provedor de negativação dos títulos, permitido somente Serasa ou Boa Vista String 15 Não
possuiNegativacaoAtiva Parâmetro utilizado para buscar títulos que possuam negativação ativa ou não, sendo:
S - Somente títulos com negativação ativa
N - Somente títulos que já possuíram negativação, porem não está mais negativado
Vazio ou não enviar - Ambos		 String 1 Não
codigoSistemaGestaoCliente Código do cliente no sistema de gestão String 50 Não
documentoPessoa Documento da pessoa, sendo:
- CNPJ quando for pessoa jurídica
- Raiz do CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15 Não
tipoPessoa Tipo da pessoa, sendo:
J - Jurídica
F - Física
E - Exportação		 String 1 Não
nomeOrigem Nome da origem de informação cadastral String 40 Não
codigoTitulo Código de um título específico a ser buscado String 30 Não
documentoTitulo Documento de títulos a serem buscados String 30 Não
dataVencimentoTituloInicial Data inicial para busca de títulos através do campo data de vencimento dos títulos DateTime Formato 'dd/mm/aaaa' Não
dataVencimentoTituloFinal Data final para busca de títulos através do campo data de vencimento dos títulos DateTime Formato 'dd/mm/aaaa' Não
token Token gerado via API do Deps String Não
}

Detalhes

# Comportamentos dos filtros

Obrigatoriedade de filtros:

  • Ao menos um dos seguintes filtros deve ser informado: Documento Pessoa, Provedor, Código Título, Documento Título, Código Sistema de Gestão Pessoa ou Datas de vencimento.
  • Ao informar Código Sistema de Gestão Pessoa, Nome Origem é obrigatório.
  • Para realizar filtro por data de vencimento de títulos, data inicial e final devem ser informadas.
  • Ao filtrar por Documento Pessoa, Tipo Pessoa e Nome Origem são obrigatórios.

Retorno:

  • Ao filtrar por títulos específicos, usando Código Título ou Documento Título, mesmo caso título nunca tenha sido negativado, ele será retornado pela API.
  • Ao filtrar de modo mais abrangente, sem informar Código Título ou Documento Título, serão retornados somente títulos que já passaram pela negativação em algum momento.
Exemplo layout JSON 
{
  "provedor": "string",
  "possuiNegativacaoAtiva": "string",
  "codigoSistemaGestaoPessoa": "string",
  "documentoPessoa": "string",
  "tipoPessoa": "string",
  "nomeOrigem": "string",
  "codigoTitulo": "string",
  "documentoTitulo": "string",
  "dataVencimentoTituloInicial": "string",
  "dataVencimentoTituloFinal": "string"
}

# Layout de retorno

Segue abaixo os campos retornados ao consultar a lista de negociações:

Campo Descrição Tipo Tam.
[{
documentoPessoa Documento da pessoa relacionado ao título retornado, sendo:
- CNPJ quando for pessoa jurídica
- Raiz do CNPJ quando for pessoa jurídica
- CPF quando for pessoa física
- Código identificador para tipo Exportação		 String 15
nomeOrigem Nome da origem de informação cadastral do título. String 40
documentoTitulo Documento do título retornado. String 30
codigoTitulo Código do título retornado. String 30
dataEmissao Data de emissão do título. DateTime Formato: dd/MM/yyyy HH:mm:ss
dataVencimento Data de vencimento do título. DateTime Formato: dd/MM/yyyy HH:mm:ss
valor Valor total do título Decimal
saldo Saldo atual do título Decimal
negativacoes: [{
provedor Provedor relacionado a negativação do título String 15
possuiNegativacaoAtiva Sim - Título possui negativação ativa
Não - Título não possui negativação ativa		 String 3
dataUltimaAlteracao Data da última movimentação relacionada a negativação.
Caso possua negativação ativa, informa a data da negativação.
Caso não possua negativação ativa, mas já esteve negativado, informa a data em que foi removido da negativação.
Caso nunca tenha sido negativado, retorna vazio		 DateTime Formato: dd/MM/yyyy HH:mm:ss
}]
historicoRemessas: [{
provedor Provedor relacionado a remessa. String 15
tipoRemessa Tipo da remessa, sendo:
0 - Excluída
1 - Ativa
2 - Atualização		 Int
statusRemessa Status da remessa, sendo:
1 - Confirmado
2 - Possui inconsistência
3 - Aguardando retorno		 Int
numeroRemessa Número da remessa Int
dataRemessa Data da geração da remessa. DateTime Formato: dd/MM/yyyy HH:mm:ss
dataConfirmacao Data em que o provedor recebeu e confirmou a remessa de negativação DateTime Formato: dd/MM/yyyy HH:mm:ss
dataLeitura Data em que o retorno da remessa foi processado no Deps Net. DateTime Formato: dd/MM/yyyy HH:mm:ss
}]
paramCategorias: [{
nomeCategoria Nome de categoria relacionada ao título. String 30
nomeParamCategoria Nome da parametrização categoria relacionada a categoria. String 100
codigoSistemaGestaoParamCategoria Código sistema de gestão da parametrização de categoria relacionada a categoria. String 100
}]
}]

← Integrações →