# Requisições

# Layout de Requisição de Limite

A API requisição de limite cliente está disponível para que seja possível a solicitação de um limite de crédito para um cliente, através de um usuário específico do DepsNet.

Através desta API é possível criar uma requisição para um usuário comum, onde ele poderá efetuar a análise da mesma e atender ou não o limite solicitado, assim como criar uma requisição de limite para o usuário sistema, onde a automação de crédito do DepsNet efetuará a análise de forma automática e tentará atender o limite solicitado caso possua alçada, ou caso contrário negar a solicitaçã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 dessa API deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Requisicoes/Requisicoes_requisicaoLimitesV1 (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 Rest Requisicao

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
codigoInformacaoCadastral	Código do sistema de gestão para informação cadastral	String	50	Sim
valorLimiteRequisitado	Valor do limite requisitado para o cliente	Decimal	18,2	Sim
adotarMaximoAlcada	Campo que define se o sistema deve tentar adotar o limite máximo permitido pela a alçada. Válido apenas para o usuário sistema como destinatário.	Boolean	N/A	Sim
adotarLimiteSugerido	Campo que define se o sistema deve tentar adotar o limite sugerido do cliente. Válido apenas para o usuário sistema como destinatário.	Boolean	N/A	Sim
dataValidadeRequisicao	Data da validade da requisição Formato: dd/mm/aaaa	Date	10	Sim
loginUsuarioSolicitante	Login do usuário que está efetuando a requisição	String	40	Sim
loginUsuarioDestinatario	Login do usuário que deverá efetuar a análise da requisição	String	40	Sim
nomeMotivo	Descrição do motivo da requisição	String	50	Não
observação	Observação da requisição	String	8000	Não
token	Token gerado via API do Deps	String		Não
credenciais: [ {
tipoConsulta	Tipo da consulta do provedor	String		Não
login	Login do provedor	String		Não
senha	Senha do provedor	String		Não

Exemplo layout JSON

{
  "tipo": "F",
  "documento": "12345678901234",
  "nomeOrigem": "Nome",
  "codigoInformacaoCadastral": "CDG11202",
  "valorLimiteRequisitado": 5600.00,
  "adotarMaximoAlcada": false,
  "adotarLimiteSugerido": false,
  "dataValidadeRequisicao": "01/01/2019",
  "loginUsuarioSolicitante": "analistaJoao",
  "loginUsuarioDestinatario": "analistaMaria",
  "nomeMotivo": "Motivo da requisição",
  "observacao": "Observações",
  "credenciaisProvedor": [
    {
      "tipoConsulta": "",
      "login": "LoginProvedor",
      "senha": "SenhaProvedor"
    }
  ]
}

# Layout de Retorno de Requisição de Limite

Segue abaixo os campos retornados ao efetuar uma requisição de limite cliente:

Campo	Descrição	Tipo	Tam.
{
codigoRequisicao	Código da requisição gerada no DepsNet	Integer
situacaoRequisicao	Situação da requisição efetuada. As seguintes situações podem ser retornadas Pendente, Atendida, Não atendida, Cancelado.	String	20
limiteFoiAdotado	Define se o limite requisitado foi adotado	Boolean
valorLimiteAdotado	Valor do limite adotado atual do cliente	Decimal	18,2
valorLimiteDisponivel	Valor do limite disponível atual do cliente.	Decimal	18,2
dataValidadeAnalise	Data da validade da análise de crédito atual do cliente	String	10
observacao	Observação gerada pelo sistema.	String	100
usuariosComAlcada	Indisponível no momento

# Layout de Requisição de Operação

A API requisição de operação está disponível para que seja possível a solicitação de um limite de crédito para um cliente, porém levando em conta uma operação que está sendo realizada, como por exemplo um pedido, através de um usuário específico do DepsNet. Ao enviar um valor de operação, o DepsNet irá analisar o limite atual tomado pelo cliente, e somará este valor com o da operação, chegando assim a um valor de limite necessário para atender aquela operação. Será então este o valor que o DepsNet utilizará para criar uma requisição de limite.

Através desta API é possível criar uma requisição para um usuário comum, onde ele poderá efetuar a análise da mesma e atender ou não o limite necessário, assim como criar uma requisição de limite para o usuário sistema, onde a automação de crédito do DepsNet efetuará a análise de forma automática e tentará atender o limite necessário caso possua alçada, ou caso contrário negar a solicitação.

Para consultar a estrutura dessa API deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Requisicoes/Requisicoes_requisicaoOperacoesV1 (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 2 REST Requisicao

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
codigoInformacaoCadastral	Código do sistema de gestão para informação cadastral	String	50	Sim
valorOperacaoRequisitado	Valor da operação requisitada para análise. Este valor será utilizado para calcular o limite necessário a ser adotado para o cliente.	Decimal	18,2	Sim
adotarMaximoAlcada	Campo que define se o sistema deve tentar adotar o limite máximo permitido pela a alçada. Válido apenas para o usuário sistema como destinatário. Se enviado valor no campo valorOperacaoRequisitado, o mesmo somado ao limite tomado atual, serão utilizados como parâmetro para verificar se o máximo da alçada atenderá ou não o limite requisitado, neste caso o limite necessário.	Boolean	N/A	Sim
adotarLimiteSugerido	Campo que define se o sistema deve tentar adotar o limite sugerido do cliente. Válido apenas para o usuário sistema como destinatário.	Boolean	N/A	Sim
dataValidadeRequisicao	Data da validade da requisição. Formato: dd/mm/aaaa	Date	10	Sim
loginUsuarioSolicitante	Login do usuário que está efetuando a requisição	String	40	Sim
loginUsuarioDestinatario	Login do usuário que deverá efetuar a análise da requisição	String	40	Sim
nomeMotivo	Descrição do motivo da requisição. (Necessário cadastro prévio)	String	50	Não
observacao	Observação da requisição. (Texto livre)	String	8000	Não
token	Token gerado via API do Deps	String		Não
} ]

Exemplo layout JSON

{
  "tipo": "J",
  "documento": "12345678901234",
  "nomeOrigem": "Nome",
  "codigoInformacaoCadastral": "CDG0021",
  "valorOperacaoRequisitado": 2000,
  "adotarMaximoAlcada": true,
  "adotarLimiteSugerido": false,
  "dataValidadeRequisicao": "01/01/2019",
  "loginUsuarioSolicitante": "analistaMaria",
  "loginUsuarioDestinatario": "analistaJoao",
  "nomeMotivo": "Motivo da requisição",
  "observacao": "Observações"
}

# Layout de Retorno de Requisição de Operação

Segue abaixo os campos retornados ao efetuar uma requisição de limite cliente:

Campo	Descrição	Tipo	Tam.
{
codigoRequisicao	Codigo da requisição gerada no DepsNet	Integer
situacaoRequisicao	Situação da requisição efetuada.As (opens new window) seguintes situações podem ser retornadas: Pendente Atendida Não atendida Cancelado	String	20
limiteFoiAdotado	Define se o limite requisitado foi adotado	Boolean
valorLimiteAdotado	Valor do limite adotado atual do cliente	Decimal	24,6
valorLimiteDisponivel	Valor do limite disponível atual do cliente	Decimal	18,2
dataValidadeAnalise	Data da validade da análise de crédito atual do cliente	String	10
observacao	Observação gerada pelo sistema	String	100
usuariosComAlcada	Indisponível no momento
}

# Layout de Requisição de Listar Requisições

A API listar requisição está disponível para que seja possível listar as requisições criadas no sistema Deps. Através dela é possível obter informações detalhadas sobre as requisições. Para auxiliar os usuários, ela possui algumas possibilidades de filtros, onde é possível buscar apenas um grupo de informações especifico com a utilização deles. Caso nenhum filtro seja informado, a API irá retornar todas as requisições que estajam com a situação Pendente no Deps.

Para consultar a estrutura dessa API deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Requisicoes/Requisicoes_RequisicaoListarRequisicoes (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 3 REST Requisicao

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

*Os campos tipoPessoa, documento, nomeOrigem e codigoSistemaGestaoCliente não são obrigatórios, mas caso documento ou codigoSistemaGestaoCliente sejam informados, eles deverão atender as seguintes combinações: "codigoSistemaGestaoCliente + nomeOrigem" ou "documento + tipoPessoa + nomeOrigem"

Campo	Descrição	Tipo	Tam.	Obr.
[ {
tipoPessoa	Tipo da pessoa, sendo: J - Jurídica F - Física E - Exportação	String	1	Não*
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	Não*
codigoSistemaGestaoCliente	Código do sistema de gestão do cliente	String	50	Não*
nomeOrigem	Nome da origem de informação cadastral	String	40	Não*
usuarioSolicitante	Nome do usuário que efetou a requisição	String	40	Não
usuarioDestinatario	Nome do usuário que deverá efetuar a análise da requisição	String	40	Não
dataCadastroInicial	Data inicial de cadastro da requisição. Formato: dd/mm/aaaa	Date	10	Não
dataCadastroFinal	Data final de cadastro da requisição. Formato: dd/mm/aaaa	Date	10	Não
dataValidadeInicial	Data inicial de validade da requisição. Formato: dd/mm/aaaa	Date	10	Não
dataValidadeFinal	Data final de validade da requisição. Formato: dd/mm/aaaa	Date	10	Não
tipoRequisicao	Tipo de requisição efetuada, sendo: Prospecção Limite Limite Especial Por Valor Tarefa Limite Especial Por Critério Limite Especial Aprova Tudo	String	30	Não
situacao	Tipo de requisição efetuada, sendo: Pendente Atendida Não Atendida Cancelado	String	15	Não
token	Token gerado via API do Deps	String		Não
} ]

Exemplo layout JSON

{
  "tipoPessoa": "J",
  "documento": "12345678901234",
  "codigoSistemaGestaoCliente": "CDG0021",
  "nomeOrigem": "Nome",
  "usuarioSolicitante": "Nome usuario",
  "usuarioDestinatario": "Nome usuario",
  "dataCadastroInicial": "01/01/2019",
  "dataCadastroFinal": "01/03/2019",
  "dataValidadeInicial": "01/04/2019",
  "dataValidadeFinal": "01/05/2019",
  "tipoRequisicao": "Limite",
  "situacao": "Atendida"
}

# Layout de Retorno de Listar Requisições

Segue abaixo os campos retornados ao efetuar uma requisição de limite cliente:

Campo	Descrição	Tipo	Tam.
{
codigo	Codigo da requisição gerada no DepsNet	Integer
dataCadastro	Data de cadastro da requisição	String	20
tipoPessoa	Tipo de pessoa do cliente	String	15
documento	Documento do cliente	String	15
nome	Nome do cliente	String	200
codigoSistemaGestaoCliente	Código do cliente no sistema de gestão	String	50
origem	Nome da origem do cliente	String	40
tipoRequisicao	Tipo da requisição	String	30
situacao	Nome da situação	String	15
usuarioSolicitante	Nome do usuário solicitante	String	40
usuarioDestinatario	Nome do usuário destinátario	String	40
usuarioAlteracao	Nome do último usuário que alterou a requisição	String	40
limite	Valor do limite	Decimal	18,2
validade	Data de validade	String	10
motivo	Nome do motivo	String	50
observacao	Observação	String	8000
}

# Layout de Requisição de Alterar Requisições

A API alterar requisição está disponível para que seja possível alterar as requisições de limite no sistema Deps. Através dela é possível realizar alterações nas requisições de limite, onde além de alterar a situação das requisições também será possível alterar as informações contidas nela.

Para consultar a estrutura dessa API deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Requisicoes/Requisicoes_RequisicaoAlterarRequisicoes (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 4 REST Requisicao

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

Campo	Descrição	Tipo	Tam.	Obr.
[ {
codigo	Codigo da requisição gerada no DepsNet	Integer		Sim
situacao	Nome da situação	String	15	Não
limite	Valor do limite	Decimal	18,2	Não
validade	Data de validade Formato: dd/mm/aaaa	String	10	Não
motivo	Código do motivo no sistema de gestão	String	50	Não
observacao	Observação	String	8000	Não
usuario	Login do usuário no Deps	String	40	Sim
token	Token gerado via API do Deps	String		Não
} ]

Exemplo layout JSON

{
  "codigo": "6094",
  "situacao": "Atendida",
  "limite": "5000",
  "validade": "01/03/2019",
  "motivo": "Motivo",
  "observacao": "Observação da requisição",
  "usuario": "login",
  "token": "3cIgpd8/ady+HNL702BPZPkUk1FF2i4kg1Bj4FKJNdRkiF3GyYWb3Lk1BwJS0HNI"
}

# Layout de Retorno de Alterar Requisições

Segue abaixo os campos retornados ao efetuar uma requisição de limite cliente:

Campo	Descrição	Tipo	Tam.
{
codigo	Codigo da requisição gerada no DepsNet	Integer
dataCadastro	Data de cadastro da requisição	String	20
tipoPessoa	Tipo de pessoa do cliente	String	15
documento	Documento do cliente	String	15
nome	Nome do cliente	String	200
codigoSistemaGestaoCliente	Código do cliente no sistema de gestão	String	50
origem	Nome da origem do cliente	String	40
tipoRequisicao	Tipo da requisição	String	30
situacao	Nome da situação	String	15
usuarioSolicitante	Nome do usuário solicitante	String	40
usuarioDestinatario	Nome do usuário destinátario	String	40
usuarioAlteracao	Nome do último usuário que alterou a requisição	String	40
limite	Valor do limite	Decimal	18,2
validade	Data de validade	String	10
motivo	Nome do motivo	String	50
observacao	Observação	String	8000
}

← Integrações Token →