# Integrações

# Cadastro de Pessoa

O cadastro de pessoas na integração de dados WebService 3.0 representa para o DepsNet o cadastro de clientes e representantes. Através dessa integração será possível realizar o próprio cadastro do cliente ou representante e também a integração de associação das informações referentes a endereço, contato, bloqueios, representantes, informação complementar, informação cadastral ao cliente.

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 integraçõ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 de integrações” 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 integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_pessoa (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 Integração

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obrig.
[ {
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
tipoRelacionamento	Tipo de relacionamento da pessoa, sendo: C - Cliente R - Representante	String	1	Sim
token	Token gerado via API do Deps	String		Não
pessoa {
codigoSistemaGestao	Código identificador da pessoa no Sistema de Gestão	String	50	Não
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	Sim
razaoSocial	Razão social quando tipo pessoa for "J". Caso contrário deve ser enviado em branco	String	200	Sim (obrigatório somente para o tipo pessoa "J")
rg	Registro geral quando tipo pessoa for "F". Caso contrário deve ser enviado em branco	String	20	Não
inscricaoEstadual	Inscrição estadual quando tipo pessoa for "J". Caso contrário deve ser enviado em branco	String	30	Não
dataNascimento	Data de nascimento quando tipo pessoa for "F". Data de fundação quando tipo pessoa for "J". Caso contrário deve ser enviado em branco. Formato: dd/MM/aaaa HH:mm:ss Obs.: Para clientes já cadastrados no Deps, essa informação só será atualizada se a parametrização “Atualizar data fundação/nascimento via integração” estiver como “Sim” e o cliente não possuir consulta.	DateTime		Não
cedente	Pessoa cedente quando tipo relacionamento for "C", caso contrário enviar em branco, sendo: S - Sim N - Não	String	1	Não
pais	País do cliente quando tipo pessoa for "E". Caso contrário deve ser enviado em branco	String	50	Não
complemento	Complemento da pessoa quando tipo pessoa for "E". Caso contrário deve ser enviado em branco	String	50	Não
dataClienteDesde	Data de cadastro do cliente na organização quando tipo relacionamento for "C". Caso contrário deve ser enviado em branco Formato: dd/MM/aaaa HH:mm:ss	DateTime		Não
contribuinteIcms	Se cliente é contribuinte ICMS ou não. 0 = Não 1 = Sim	Int		Não
tipoFaturamento	Descrição do tipo faturamento do cliente	String	50	Não
codigoColigado	Código do coligado no sistema de gestão	String	100	Não
nomeColigado	Nome do coligado no sistema de gestão	String	300	Não
}
endereco {
cidade	Nome da cidade. Obs.: Caso a cidade não esteja cadastrada no DepsNet. O cadastro será feito automaticamente conforme a informação de UF enviada	String	50	Sim
uf	Unidade federativa do endereço do cliente. Caso o tipo da pessoa for "E" deve ser sempre enviado a informação como "EX"	String	2	Sim
rua	Nome da rua	String	200	Não
bairro	Nome do bairro	String	100	Não
cep	Código de endereço postal do logradouro	String	10	Não
numero	Número do logradouro	String	15	Não
complemento	Complemento do logradouro	String	80	Não
tipoEndereco	Tipo do endereço pode ser 1 - Faturamento 2 - Cobrança 3 - Comercial 4 - Residencial 5 - Entrega Obs.: É dado preferência ao endereço de tipo cobrança.	Int		Não
confirmado	Confirmação de endereço de entrega. 0 – Não confirmado. 1 - Confirmado	Int		Não Caso não seja informado ao adicionar um endereço, será considerado não confirmado. Caso o endereço já estiver cadastrado pro cliente e confirmado, o confirmado enviado na integração será desconsiderado. Caso não seja informado ou seja enviado como não confirmado e o endereço seja do Tipo Entrega, será verificado se o codigoPessoa já possui um endereço com as mesmas informações, caso possua e este endereço esteja confirmado no sistema, será atribuido confirmado.
apelido	Nome ou descrição associada a endereço de entrega	String	200	Não Campo obrigatório caso o tipo endereço seja Entrega.
}
enderecos [ {
cidade	Nome da cidade. Obs.: Caso a cidade não esteja cadastrada no DepsNet. O cadastro será feito automaticamente conforme a informação de UF enviada	String	50	Sim
uf	Unidade federativa do endereço do cliente. Caso o tipo da pessoa for "E" deve ser sempre enviado a informação como "EX"	String	2	Sim
rua	Nome da rua	String	200	Não
bairro	Nome do bairro	String	100	Não
cep	Código de endereço postal do logradouro	String	10	Não
numero	Número do logradouro	String	15	Não
complemento	Complemento do logradouro	String	80	Não
tipoEndereco	Tipo do endereço pode ser 1 - Faturamento 2 - Cobrança 3 - Comercial 4 - Residencial 5 - Entrega Obs.: É dado preferência ao endereço de tipo cobrança.	Int		Não
confirmado	Confirmação de endereço de entrega. 0 – Não confirmado. 1 - Confirmado	Int		Não Caso não seja informado ao adicionar um endereço, será considerado não confirmado. Caso o endereço já estiver cadastrado pro cliente e confirmado, o confirmado enviado na integração será desconsiderado.
apelido	Nome ou descrição associada a endereço de entrega	String	200	Não Campo obrigatório caso o tipo endereço seja Entrega.
} ]
contatos [ {
preferencial	Contato preferencial, sendo: S - Sim N - Não Obs.: É possível ter somente um contato preferencial por pessoa, onde se for enviado outro preferencial o anterior será alterado para "N"	String	1	Sim
nome	Nome do contato. Obs.: É utilizado como chave ao adicionar, excluir e editar contatos	String	200	Sim
cargo	Cargo do contato	String	100	Não
telefone	Telefone do contato	String	25	Não* É necessário ter ao menos uma informação de contato (telefone, celular, e-mail ou observação)
celular	Celular do contato	String	25	Não*
email	E-mail do contato. Obs.: É possível cadastrar mais de um e-mail para o mesmo contato, separando a cada informação por ";"	String	200	Não*
observação	Observação do contato. Podendo ser também qualquer outra informação de contato da pessoa	String	250	Não*
excluir	Para excluir o contato da pessoa deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro de contato no DepsNet	String	1	Não
ativo	Define se o contato deve ser ativo ou inativo. 0 - Inativo. 1 - Ativo	Int	1	Não* Quando não informado, sistema considerará que o contato deve ser ativo.
} ]
informacoesComplementares [ {
complemento	Complemento da informação complementar. Obs.: Essa informação é considerada única. Se enviar um complemento já cadastrado será atualizado as outras informações. Se a informação desse campo não possuir no DepsNet ainda será cadastrado um novo complemento	String		Sim
dataCadastro	Data de cadastro da informação complementar, sendo que, se for enviado em branco será utilizado a data atual. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Não
login	Usuário que inseriu a informação complementar. Essa informação corresponde ao campo "login" do usuário no DepsNet. Caso enviado em branco, a informação complementar será cadastrada como usuário "administrador"	String	40	Não
excluir	Para excluir a informação complementar da pessoa deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String	1	Não
} ]
informacoesCadastrais [ {
desassociar	Para desassociar a informação cadastral da pessoa deve ser enviado "S". Onde caso enviado um codigoSistemaGestao, irá desassociar apenas a informação cadastral informada, senão irá desassociar todas as informações cadastrais do cliente. Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String	1	Não
codigoSistemaGestao	Código identificador da informação cadastral no sistema de gestão. Obs.: o sistema mantem apenas uma informação cadastral por subgrupo de informação cadastral, de acordo com a parametrização de sistema "Desassociar ao associar informação cadastral".	String	50	Sim
nome	Nome da informação cadastral. Obs.: Campo utilizado para o cadastro da informação cadastral quando a mesma não existir no sistema.	String	50	Sim
codigoSistemaGestaoSubGrupo	Código identificador do subgrupo de informação cadastral no sistema de gestão. Obs.: Campo utilizado para o cadastro da informação cadastral quando a mesma não existir no sistema	String	50	Não
} ]
bloqueios [ {
codigo	Código identificador do bloqueio no sistema de gestão	String	10	Sim
desassociar	Para desassociar o bloqueio da pessoa deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String	1	Não
dataDesbloqueio	Data em que foi realizada a inativação do bloqueio (desbloqueio) Formato: dd/MM/aaaa	DateTime		Não
} ]
grupoEconomico {
codigoSistemaGestao	Código identificador do grupo no sistema de gestão	String	50	Sim* Obs.: Não obrigatório se campo desassociar igual a "S"
desassociar	Para desassociar o grupo da pessoa deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String	1	Não
nome	Para o cadastro de um novo grupo é obrigatório informar o nome. Caso seja uma associação e for informado o nome, o grupo é atualizado com o nome inserido	String	100	Não
}
representante {
Tipo	Tipo da pessoa, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim* Obs.: Não obrigatório se campo desassociar igual a "S"
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* Obs.: Não obrigatório se campo desassociar igual a "S"
desassociar	Para desassociar o representante da pessoa deve ser enviado "S". Caso contrário deve ser enviado em branco. Para que todos os representantes sejam desassociados da pessoa, deve-se enviar em branco os campos "tipo" e "documento". Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet String	1	Não
}
representantes [ {
Tipo	Tipo da pessoa, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim* Obs.: Não obrigatório se campo desassociar igual a "S"
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* Obs.: Não obrigatório se campo desassociar igual a "S"
desassociar	Para desassociar o representante da pessoa deve ser enviado "S". Caso contrário deve ser enviado em branco. Para que todos os representantes sejam desassociados da pessoa, deve-se enviar em branco os campos "tipo" e "documento". Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet String	1	Não
} ]
faturamentosDeclarados [ {
dataOperacao	Data da operação (faturamento)	DateTime		Sim
valorFaturamento	Valor somado da operação no mês (faturamento)	Decimal	18,2	Sim
} ]
indiceFaturamentoResumido {
valorElegivel	Valor em reais que se considera recebível para desconto	Decimal	18,2	Sim
prazo	Prazo de pagamento praticado pelo Cedente com seus clientes. (Em dias PMP).	Int		Sim
endividamento	Endividamento bancário do cedente.	Decimal	18,2	Sim
share	Percentual que nos interessamos em operar do cliente.	Decimal	18,2	Sim
}
contasReceberAnaliticoInformacoesConsolidadas {
periodo	Data do período mensal.Formato: dd/mm/aaaaDeve sempre ser enviado com dia 01. Caso diferente disso então o sistema assume a data com dia 01.	Datetime		Sim
valor	Valor total emitido no período (mês fechado)	Decimal	18,2	Sim
liquidez	Percentual de liquidez dos pagamentos, ou seja, percentual efetivo do valor que foi recebido.	Decimal	18,2	Sim
recompra	Percentual de recompra de títulos.	Decimal	18,2	Sim
}
contasReceberAnaliticoValoresEmAberto {
valorAVencer	Valor total de a vencer.	Decimal	18,2	Sim
valorVencido	Valor total de vencido	Decimal	18,2	Sim
}
dadosProfissionais [ {
uf	Unidade Federativa (Estado)	String	2	Sim* Obs.: Caso o tipo de registro profissional esteja parametrizado no DepsNet para não receber Uf, caso esta seja enviada, será desconsiderada.
numeroRegistro	Número do registro	String	30	Sim
tipoRegistroProfissional	Tipo de registro profissional. Tipos presentes no DepsNet: CRO, CRMV, ANVISA	String	30	Sim
ativo	Se o registro está ativo -"S" para Sim -"N" para Não Obs.: Não enviando o registro será considerado como inativo se não existir outro registro na base	String	1	Não* Obs.: Quando não enviado ou enviado com String vazia, o campo será desconsiderado ao validar o bloqueio de tipo de registro profissional divergente, e caso exista um registro ativo, não ira inativar.
codigoAreaAtuacao	Código da área de atuação do registro	String	30	Sim* Obs.: Caso o tipo de registro profissional esteja parametrizado no DepsNet para não receber Área de atuação, caso esta seja enviada, será desconsiderada.
} ]
respostasQuestionarios [ {
pergunta	Descrição da pergunta	String	300	Sim
resposta	Descrição da resposta	String	100	Sim
dataValidade	Data de validade da resposta Formato: dd/MM/aaaa HH:mm:ss	Datetime		Não* Obs.: Quando não enviado não será adicionado data de validade a resposta, e quando enviada se a data for maior que a data limite calculada baseada nos meses configurados na pergunta, será considerada e salva a data limite.
} ]
} ]

Observações

Se o endereço estiver confirmado e a única alteração for o apelido, a informação de confirmado vinda da integração será ignorada.

Campos de Nome e Razão Social não aceitam a sequência de caracteres '&#', quando enviados o sistema adicionará um espaço entre os caracteres, para evitar problemas na visualização do cliente.

Exemplo layout JSON

[{
    "tipo": "J",
    "documento": "00000000000000",
    "nomeOrigem": "Sistema de Gestão",
    "tipoRelacionamento": "C",
    "token": "token",
    "pessoa": {
	    "codigoSistemaGestao": "CDGsg002212",
		"nome": "NOME",
		"razaoSocial": "",
		"rg": "888555333",
		"inscricaoEstadual": "",
		"dataNascimento": "24/11/1991",
		"cedente": "",
		"pais": "",
		"complemento": "",
		"dataClienteDesde": "",
      "codigoColigado": "cod123",
      "nomeColigado": "Nome"
     },
    "endereco": {
        "cidade": "criciuma",
        "uf": "sc",
        "rua": "Rua Santos Drumont",
        "bairro": "São Luiz",
        "cep": "888000222",
        "numero": "320",
        "complemento": "",
        "tipoEndereco": "3",
        "confirmado": 0,
        "apelido": "Minha casa"
    },
    "contatos": [{
        "preferencial": "N",
        "nome": "Nome do Contato",
        "cargo": "Cargo do Contato",
        "telefone": "Telefone do Contato",
        "celular": "48999998888",
        "email": "[email protected]",
        "observação": "",
        "excluir": "",
        "ativo": 1,        
    }],
    "informacoesComplementares": [{
        "complemento": "Complemento",
        "dataCadastro": "",
        "login": "LoginUsuario",
        "excluir": ""
    }],
    "informacoesCadastrais": [{
        "desassociar": "",   
        "codigoSistemaGestao": "CODGsg66532",
        "nome": "NOME INFO CADASTRAL",
        "codigoSistemaGestaoSubGrupo": "000"
    }],
    "bloqueios": [{
        "codigo": "CDGsgBloq0030",
        "desassociar": "S",
        "dataDesbloqueio": "01/01/2020"
    }],
    "grupoEconomico":{
        "codigoSistemaGestao": "CDGsgGrp56565",
        "desassociar": ""
    },
    "representante": {
        "Tipo": "F",
        "documento": "123456789012345",
        "desassociar": ""
    },
    "faturamentoDeclarados": [{
        "dataOperacao": "01/01/2019",
        "valorFaturamento": "3260,25"
    }],
    "indiceFaturamentoResumido":{
        "valorElegivel": "545.12",
        "prazo": "30",
        "endividamento": "1200.35",
        "share": "12.3"
    },
    "contasReceberAnaliticoInformacoesConsolidadas":{
        "periodo": "01/01/2020",
        "valor": "2500.12",
        "liquidez": "12.50",
        "recompra": "6.3"
    },
    "contasReceberAnaliticoValoresEmAberto": {
        "valoresAVencer": "5300.45",
        "valorVencido": "3001.87"
    },
    "dadosProfissionais": [{
        "uf": "SC",
        "numeroRegistro": "12931",
        "tipoRegistroProfissional": "CRO",
        "ativo": "N",
        "codigoAreaAtuacao": "CD"
    }],
    "respostasquestionarios": [{
        "pergunta": "Possui bom histórico?",
        "resposta": "Sim",
        "dataValidade": ""
    }]
}]

# Cadastro de Pedido

Através dessa integração será possível cadastrar as informações de pedido e associações com situação, informação complementar, parametrização de categoria, item produto e motivos.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_pedido (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:

Imagem2 Rest Integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam	Obrig.
[ {
Código	Código do pedido para identificação no DepsNet, onde o mesmo deve ser único	String	30	Sim
token	Token gerado via API do Deps	String		Não
pedido {
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, 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
codigoOriginal	Código ou número original do pedido	String	30	Sim
codigoPedido	Código identificador do pedido no sistema de gestão	String	30	Sim
dataEmissao	Data de emissão do pedido. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
dataPrimeiroVencimento	Data do primeiro vencimento do pedido ou data de vencimento da primeira parcela do pedido. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
valorBruto	Valor bruto do pedido. Exemplo de formato: 1000.00	Decimal	18,2	Sim
valorEntrada	Valor pago de entrada do pedido. Exemplo de formato: 1000.00	Decimal	18,2	Sim
valorLiquido	Valor líquido do pedido. Exemplo de formato: 1000.00	Decimal	18,2	Sim
valorSaldo	Valor de saldo do pedido.Exemplo de formato: 1000.00	Decimal	18,2	Sim
tipoRepresentante	Tipo do representante, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoRepresentante	Documento do representante, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
tipoPagamento	Forma de pagamento, sendo: 0 - A prazo 1 - À vista 2 - Antecipado	Int		Sim
dataAtualizaSituacao	Data que a partir desta o pedido poderá ser alterado a situação, ou seja analisado.Formato: dd/MM/aaaa HH:mm:ss	DateTime		Não
dataFaturamento	Data de faturamento do pedidoFormato: dd/MM/aaaa HH:mm:ss	DateTime		Não
diasEntreParcelas	Quantidade de dias entre as parcelas do pedido.	Int		Não
Prazo	Prazo do pedido, onde deve ser separado por barras. Exemplo: 30/60/90	String	150	Não
quantidadeParcelas	Quantidade de parcelas do pedido.	Int		Não
codigoMoeda	Sigla da moeda utilizada no pedido.Podendo ser BRL, ARS ou USD. Quando enviado na integração a informação diferente de BRL o DepsNet irá buscar a cotação da moeda do dia anterior da data de emissão do pedido e realizado a conversão dos valores do pedido para Reais. Quando não encontrado a cotação do dia anterior da data de emissão do pedido, não será realizado a integração e será retornado uma mensagem pelo serviço.	String	3	Não
solicitante	Solicitante do pedido	String	90	Não
}
clientesRelacionados[{
Obs.: Esse bloco tem o comportamento de “espelhamento”, mantendo ativos somente os clientes que vieram na última integração, e desassociando os excedentes caso existam. Porém em caso de algum erro ao associar um novo cliente, esse comportamento será revogado, passando a somente associar os clientes possíveis, e não mais desassociando os já existentes que não vieram juntamente na integração.
desassociar	Para desassociar o cliente do pedido deve ser enviado “S”. Se enviado o campo “documento” e o campo “tipoRelacao” em branco, serão desassociados todos os clientes do pedido. Se enviado o campo “documento” em branco, mas o campo “tipoRelacao” preenchido, serão desassociados todos os clientes do tipo enviado. Caso contrário esse campo deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String		Não
documento	Documento do cliente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Sim
origem	Nome da origem de informação cadastral	String	40	Sim
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
tipoRelacao	Tipo da relação entre o cliente e pedido, sendo: COB - Cobrança AVA - Avalista	String	3	Sim
}]
situacao {
codigoSistemaGestao	Código identificador da situação do pedido no sistema de gestão. O pedido possui somente uma situação, onde se enviar uma outra situação diferente da cadastrada para o pedido no DepsNet será inativada a anterior e inserido uma nova.	String	50	Sim
}
endereco {
desassociar	Para desassociar o endereço do pedido deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String	1	Não
cidade	Nome da cidade. Obs.: Caso a cidade não esteja cadastrada no DepsNet. O cadastro será feito automaticamente conforme a informação de UF enviada	String	50	Sim
uf	Unidade federativa do endereço do cliente. Caso o tipo da pessoa for "E" deve ser sempre enviado a informação como "EX"	String	2	Sim
rua	Nome da rua	String	200	Não
bairro	Nome do bairro	String	100	Não
cep	Código de endereço postal do logradouro	String	10	Não
numero	Número do logradouro	String	15	Não
complemento	Complemento do logradouro	String	80	Não
confirmado	Confirmação de endereço de entrega. 0 – Não confirmado. 1 - Confirmado Obs.: Caso não seja informado ao adicionar um endereço, será considerado não confirmado. Caso o endereço já estiver cadastrado pro cliente e confirmado, o confirmado enviado na integração será desconsiderado.	Int		Não*
apelido	Nome ou descrição associada a endereço de entrega.	String	200	Sim
}
divisorLimite [ {
Obs.: Esse bloco tem o comportamento de “espelhamento”, mantendo ativos somente os divisores que vieram na última integração, e desassociando os excedentes caso existam.
desassociar	Este campo foi descontinuado por conta do comportamento de espelhamento. Tag foi mantida apenas para evitar erros em integrações ja criadas.	String	1	Não
codigoSistemaGestao	Código identificador do divisor de limite do pedido no sistema de gestão. Obs.: Para a associação do divisor de limite com o pedido, o divisor deve estar parametrizado para a origem do pedido	String	50	Sim
valor	Valor do divisor de limite para o pedido.	Decimal	18,2	Sim
} ]
parametrizacoesCategorias [ {
codigoSistemaGestao	Código identificador da parametrização da categoria do pedido no sistema de gestão.A associação irá respeitar a parametrização do sistema: "Desassociar ao associar param. de categorias". Onde conforme opção definida, o pedido poderá ou não ter mais de uma parametrização de categoria da mesma categoria. Obs.: Essa parametrização pode ser acessada através da opção: Configurações / Config. Gerais / Param. do Sistema do DepsNet.	String	50	Sim
desassociar	Para desassociar a parametrização de categoria do pedido deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
nome	Nome da parametrização de categoria	String	100	Não
nomeCategoria	Nome da categoria da parametrização de categoria	String	50	Não
} ]
informacoesComplementares [ {
complemento	Complemento da informação complementar	String	8000	Sim
dataCadastro	Data de cadastro da informação complementar. Formato: dd/MM/aaaa HH:mm:ss Essa informação juntamente com o login e o código do pedido compõem a chave de identificação do complemento no DepsNet.	DateTime		Sim
login	Usuário que inseriu a informação complementar. Essa informação corresponde ao campo "login" do usuário no DepsNet. Caso enviado em branco, a informação complementar será cadastrada como usuário "administrador".Essa informação juntamente com a dataCadastro e o código do pedido compõem a chave de identificação do complemento no DepsNet.	String	40	Não
excluir	Para excluir a informação complementar do pedido deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.1: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet. Obs.2: Para exclusão do complemento será buscado no DepsNet pela informação de código do pedido, dataCadastro e login.	String	1	Não
} ]
motivos [ {
codigoSistemaGestao	Código identificador do motivo no sistema de gestão. Obs.: A informação de motivo deve estar parametrizada para a situação ativa do pedido para realizar a associação. Opção no DepsNet: Configurações / Pedidos / Motivos / Parametrização.	String	50	Sim
desassociar	Para desassociar o motivo do pedido deve ser enviado "S", caso não informado o campo "codigoSistemaGestao" todos os motivos do pedido serão desassociados. Caso contrário "desassociar" deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
} ]
itensProdutos [ {
codigoSistemaGestao	Código identificador do item produto no sistema de gestão	String	50	Sim
Quantidade	Quantidade do item produto.	String	30	Não
Desassociar	Para desassociar o item produto do pedido deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
codigoSistemaGestaoGrupoProduto	Código identificador do grupo produto no sistema de gestão	String	50	Sim
} ]
condicoesPagamento [ {
Obs.: Esse bloco tem o comportamento de "espelhamento", mantendo ativas somente as condições de pagamento que vieram na última integração, e desassociando as excedentes caso existam. Porém em caso de algum erro ao associar uma nova condição, esse comportamento será revogado, passando a somente associar as condições possíveis, e não mais desassociando as já existentes que não vieram juntamente na integração.
desassociar	Para desassociar uma condição de pagamento do pedido deve ser enviado “S”. Se enviado o campo “documento” e o campo “formaPagamento” em branco, serão desassociadas todas as condições de pagamento do pedido. Se enviado o campo “documento” em branco, mas o campo “formaPagamento” preenchido, serão desassociadas todas as condições de pagamento da forma enviada. Caso contrário esse campo deve ser enviado em branco. Obs.: Qualquer informação diferente de “S” para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
formaPagamento	Código da forma de pagamento que será usada no pagamento. Caso seja informada uma forma desconhecida durante a associação no sistema, será cadastrada automaticamente a nova forma de pagamento para relacionar com a condição de pagamento.	String	50	Sim
documento	Campo de identificação da forma de pagamento. Ex: Pedido pode ser pago com dois cartões de crédito, ou seja, duas condições de pagamento com a forma de pagamento ‘CRED’, porém com documento distintos, podendo ser o número do cartão usado como documento. Essa informação juntamente com o código do pedido compõem a chave de identificação da condição no DepsNet.	String	50	Sim
statusOperacao	Status atual da operação de pagamento. 0 - Não realizado 1 - Realizado	Int		Sim
observacao	Observação relacionada a condição de pagamento	String	300	Não
parcelas [ {
dataVencimento	Data de vencimento da parcela. Formato: dd/MM/aaaa HH:mm:ss	Datetime		Sim
valor	Valor da parcela	Decimal	18,2	Sim
observacao	Observação relacionada a parcela	String	300	Não
} ]
} ]
} ]

Observações

Se o endereço estiver confirmado e a única alteração for o apelido, a informação de confirmado vinda da integração será ignorada.

Exemplo layout JSON

[
  {
    "codigo": "CDG323232",
    "token": "token",
    "pedido": {
      "tipoCliente": "F",
      "documentoCliente": "12345678901234",
      "nomeOrigem": "Nome Origem Info Cadastral",
      "codigoOriginal": "CDGorign111",
      "codigoPedido": "CDGPEDIDO66121",
      "dataEmissao": "01/01/2019",
      "dataPrimeiroVencimento": "01/02/2019",
      "valorBruto": 1500.05,
      "valorEntrada": 750.10,
      "valorLiquido": 700.25,
      "valorSaldo": 2350.15,
      "tipoRepresentante": "J",
      "documentoRepresentante": "12345678901234",
      "tipoPagamento": 0,
      "dataAtualizaSituacao": "02/01/2019",
      "dataFaturamento": "02//01/2019",
      "diasEntreParcelas": 30,
      "prazo": "30/60/90",
      "quantidadeParcelas": 3,
      "codigoMoeda": "BRL",
      "solicitante": "NomeSolicitante"
    },
    "clientesRelacionados": [
      {
        "desassociar": "",
        "documento": "000111000123",
        "origem": "Sistema de gestão",
        "tipoCliente": "J",
        "tipoRelacao": "COB"
      }
    ],
    "situacao": {
      "codigoSistemaGestao": "CDG444"
    },
    "endereco": {
      "desassociar": "",
      "cidade": "Criciuma",
      "uf": "SC",
      "rua": "Avenida das palmeiras",
      "bairro": "Centro",
      "cep": "88888888",
      "numero": "10",
      "complemento": "Referencias do endereco",
      "confirmado": 1,
      "apelido": "Minha casa"
    },
    "divisorLimite": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CDG4454511",
        "valor": 0
      }
    ],
    "parametrizacoesCategorias": [
      {
        "desassociar": "S",
        "codigoSistemaGestao": "CDGSG0020",
        "nome": "NomeParametrizaçãoCategoria",
        "nomeCategoria": "NomeCategoria"
      }
    ],
    "motivos": [
      {
        "desassociar": "S",
        "codigoSistemaGestao": "CDG11200"
      }
    ],
    "itensProdutos": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CDG0",
        "quantidade": "60"
      }
    ],
    "informacoesComplementares": [
      {
        "excluir": "",
        "complemento": "Complemento",
        "login": "Usuario",
        "dataCadastro": "05/01/2019"
      }
    ],
    "condicoesPagamento": [
      {
        "desassociar": "",
        "formaPagamento": "BOLETO",
        "documento": "000.000.000",
        "statusOperacao": 1,
        "observacao": "Boleto de pagamento unico",
        "parcelas": [
          {
            "dataVencimento": "28/07/2021",
            "valor": 1000.00,
            "observacao": "Parcela unica"
          }          
        ]
      }
    ]
  }
]

# Cadastro de Pedido V2

Através dessa integração será possível cadastrar as informações de pedido e associações com situação, informação complementar, parametrização de categoria, item produto e motivos.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_pedidoV2 (opens new window), onde "localhost" representa o nome do servidor que está instalado a API.

Oque difere este serviço da primeira versão é o retorno em caso de erros durante a integração, retornando a mensagem de informação sobre o problema encontrado, e também o código do pedido em questão em um campo isolado, facilitando a identificação do pedido que ocorreu o problema.

# Cadastro de Título

Através dessa integração será possível cadastrar as informações de título e as associações com nota, nota complementar, cheque, parametrização de categoria e também realizar os cadastros referente a movimentação de baixa e movimentação geral do título.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_titulo (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:

Atenção

As informações de Codigo, DocumentoTitulo e NumeroBoleto podem ser utilizadas no processo de negativação Serasa, para envio no campo NossoNumero da remessa, caso sejam selecionados no momento da negativação. Para utilização com sucesso dessas informações, o valor selecionado deve seguir as exigências da Serasa, sendo composto somente de números e ter no máximo 9 dígitos. Obs.: Caracteres especiais e espaços são removidos pelo sistema no momento da geração da remessa.

Negativação Serasa, Negativação Boa Vista, Protesto Nacional, Protesto São Paulo e Escritórios de Cobrança são funcionalidades que utilizam diretamente de várias informações dos títulos, portanto caso o cliente venha utilizar um desses processos, integração deve ser pensada e realizada de maneira a fornecer dados formatados para não gerar nenhum problema nestes processos.

Imagem3 Rest Integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
codigo	Código do título para identificação no DepsNet, onde o mesmo deve ser único	String	30	Sim
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, 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
titulo {
tipoRepresentante	Tipo do representante, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoRepresentante	Documento do representante, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
documentoTitulo	Documento do título. Este campo é utilizado como agrupador de títulos, quando for realizado parcelamento de uma compra, e cada parcela for integrada como um título. Valores de data/valor da última/maior compra podem ser diretamente impactados por esse campo.	String	30	Sim
dataEmissao	Data de emissão do título. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
dataVencimentoProrrogado	Data de vencimento prorrogado do título. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
dataVencimento	Data de vencimento do título.Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
motivoProrrogacao	Motivo da prorrogação, sendo: 1 - Considera para o cálculo a data de vencimento original 2 - Considera para o cálculo da data de vencimento prorrogado	Int		Sim
parcela	Número da parcela do título	String	10	Sim
valor	Valor do título. Exemplo de formato: 1000.00	Decimal	18,2	Sim
observacao	Observação do título	String	200	Não
numeroBoleto	Número do boleto do título	String	100	Não
observacao1	Observação extra	String	200	Não
observacao2	Observação extra	String	200	Não
observacao3	Observação extra	String	200	Não
desconto	Desconto a ser aplicado ao título na recuperação de crédito. Exemplo de formato: 100.00	Decimal	18,2	Não
tipoCedente	Tipo do cedente, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoCedente	Documento do cedente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
codigoMoeda	Sigla da moeda utilizada no título.Podendo ser BRL, ARS ou USD. Quando enviado na integração a informação diferente de BRL o DepsNet irá buscar a cotação da moeda do dia anterior da data de emissão do título e realizado a conversão dos valores do pedido para Reais.Quando não encontrado a cotação do dia anterior da data de emissão do título, não será realizado a integração e será retornado uma mensagem pelo serviço.	String	3	Não
}
pedidosRelacionados [ {
desassociar	Para desassociar um pedido relacionado do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
codigoPedido	Código do pedido a ser relacionado	String	30	Sim
} ]
clientesRelacionados [ {
desassociar	Para desassociar um cliente relacionado do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documento	Documento do cliente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Sim
origem	Nome da origem de informação cadastral.	String	40	Sim
tipoRelacao	Tipo da relação entre título e cliente. AVA – Avalista PED – Cliente do pedido	String	3	Sim
} ]
divisorLimite [ {
Obs.: Esse bloco tem o comportamento de “espelhamento”, mantendo ativos somente os divisores que vieram na última integração, e desassociando os excedentes caso existam.
desassociar	Este campo foi descontinuado por conta do comportamento de espelhamento. Tag foi mantida apenas para evitar erros em integrações ja criadas.	String	1	Não
codigoSistemaGestao	Código identificador do divisor de limite do título no sistema de gestão. Obs.: Para a associação do divisor de limite com o título, o divisor deve estar parametrizado para a origem do título.	String	50	Sim
valor	Valor do divisor de limite para o título.	Decimal	18,2	Sim
} ]
parametrizacoesCategorias [ {
codigoSistemaGestao	Código identificador da parametrização da categoria do título no sistema de gestão.A associação irá respeitar a parametrização do sistema: "Desassociar ao associar param. de categorias". Onde conforme opção definida, o título poderá ou não ter mais de uma parametrização de categoria da mesma categoria. Obs.: Essa parametrização pode ser acessada através da opção: Configurações / Config. Gerais / Param. do Sistema do DepsNet.	String	50	Sim
nomeCategoria	Nome da categoria do título no sistema de gestão.	String	30	Não
desassociar	Para desassociar a parametrização de categoria do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
nome	Nome da parametrização da categoria do título no sistema de gestão.	String	100	Não
} ]
cheques [ {
numero	Número do cheque.	String	40	Sim
valorUtilizado	Valor utilizado do cheque para liquidação do título. Exemplo de formato: 1000.00	Decimal	18,2	Não
desassociar	Para desassociar o cheque do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
} ]
notas [ {
codigo	Código da nota.	String	30	Sim
desassociar	Para desassociar a nota do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
} ]
notasComplementares [ {
codigo	Código da nota complementar	String	30	Sim
desassociar	Para desassociar a nota complementar do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
} ]
movimentosGerais [ {
codigoTipoMovimento	Código do tipo de movimento geral no sistema de gestão	String	50	Sim
nomeTipoMovimento	Nome do tipo de movimento geral no sistema de gestão	String	50	Não
documento	Documento do movimento geral	String	30	Sim
dataMovimento	Data do movimento geral. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
valor	Valor do movimento geral. Exemplo de formato: 1000.00	Decimal	18,2	Sim
} ]
movimentosBaixas [ {
codigoTipoBaixa	Código do tipo de movimento de baixa no sistema de gestão	String	50	Sim
nomeTipoBaixa	Nome do tipo de movimento de baixa no sistema de gestão	String	50	Não
documento	Documento do movimento de baixa	String	30	Sim
dataBaixa	Data do movimento de baixa. Formato: dd/MM/aaaa HH:mm:ss	DateTime		Sim
valor	Valor do movimento de baixa. Exemplo de formato: 1000.00	Decimal	18,2	Sim
} ]
recuperacaoNegociacao {
codigoNegociacao	Código da negociação da recuperação de crédito	Int		Sim
numeroParcela	Número da parcela da negociação da recuperação de crédito	Int		Sim
desassociar	Para desassociar a recuperação negociação do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet.	String	1	Não
}
} ]

Exemplo layout JSON

[
  {
    "codigo": "CDG11226868",
    "tipoCliente": "F",
    "documentoCliente": "123456789012345",
    "nomeOrigem": "Nome Origem",
    "token": "token",
    "titulo": {
      "tipoRepresentante": "F",
      "documentoRepresentante": "123456789012345",
      "documentoTitulo": "DOCT00012",
      "dataEmissao": "01/01/2019",
      "dataVencimentoProrrogado": "01/01/2019",
      "dataVencimento": "01/01/2019",
      "motivoProrrogacao": 1,
      "parcela": "4",
      "valor": 6320.65,
      "observacao": "Observações",
      "numeroBoleto": "3232461",
      "observacao1": "Observações",
      "observacao2": "Observações",
      "observacao3": "Observações",
      "tipoCedente": "F",
      "documentoCedente": "12345678901234",
      "codigoMoeda": "USD"
    },
    "pedidosRelacionados": [
      {
        "desassociar": "",
        "codigo": "COD_PEDIDO"
      }
    ],
    "clientesRelacionados": [
      {
        "desassociar": "",
        "documento": "00011100022",
        "origem": "Nome da origem",
        "tipoCliente": "J",
        "tipoRelacao": "AVA"
      }
    ],
    "divisorLimite": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CDG54545",
        "valor": 36.40
      }
    ],
    "parametrizacoesCategorias": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CDGF4545",
        "nomeCategoria": "Portador"
      }
    ],
    "cheques": [
      {
        "desassociar": "S",
        "numero": "84593",
        "valorUtilizado": 4100.10
      }
    ],
    "notas": [
      {
        "desassociar": "S",
        "codigo": "CDG545451"
      }
    ],
    "notasComplementares": [
      {
        "desassociar": "",
        "codigo": "CSDF6630202"
      }
    ],
    "movimentosBaixas": [
      {
        "codigoTipoBaixa": "CDGMV7484",
        "nomeTipoBaixa": "Estorno",
        "documento": "DOC69595",
        "dataBaixa": "01/01/2019",
        "valor": 409.15
      }
    ],
    "movimentosGerais": [
      {
        "codigoTipoMovimento": "CDGMOV777",
        "nomeTipoMovimento": "Saldo",
        "documento": "DOC685",
        "dataMovimento": "01/01/2019",
        "valor": 350.0
      }
    ],
    "recuperacaoNegociacao": {
      "desassociar": "",
      "codigoNegociacao": 3,
      "numeroParcela": 8
    }
  }
]

# Cadastro de Cheque

Através dessa integração será possível cadastrar as informações de cheque.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_cheque (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 Integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, 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
valor	Valor do cheque. Exemplo de formato: 1000.00	Decimal	18,2	Sim
situacao	Sistuação do cheque, sendo: 0 - Não compensado 1 - Compensado 2 - Devolvido	Int	1	Sim
documentoEmitente	Documento do emitente do cheque, sendo esse o dono do cheque, onde deve ser enviado um CNPJ ou CPF válido	String	14	Sim
dataEmissao	Data de emissão do cheque.Formato: dd/MM/aaaa HH:mm:ss	String		Sim
cmc7	Código que não pode ser repetido, sendo assim deve ser único (Caracteres Magnéticos Codificados em 7 Barras).	String	40	Sim
numeroCheque	Número do cheque para controle interno	String	40	Não
banco	Banco do cheque	String	50	Não
agencia	Agência do banco do cheque	String	20	Não
contaCorrente	Conta corrente do cheque	String	15	Não
dataVencimento	Data de vencimento do cheque. Formato: dd/MM/aaaa HH:mm:ss	String		Não
tipoCedente	Tipo do cedente, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoCedente	Documento do cedente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
codigoSistemaGestaoParametrizacaoCategoria	Código da parametrização de categoria no sistema de gestão	String	50	Não
nomeCategoria	Nome da categoria da parametrização de categoria no sistema de gestão	String	30	Não
nomeEmitente	Nome do emitente do cheque	String	200	Não
codigoMoeda	Sigla da moeda utilizada no cheque. Podendo ser BRL, ARS ou USD. Quando enviado na integração a informação diferente de BRL o DepsNet irá buscar a cotação da moeda do dia anterior da data de emissão do cheque e realizado a conversão dos valores do cheque para Reais. Quando não encontrado a cotação do dia anterior da data de emissão do cheque, não será realizado a integração e será retornado uma mensagem pelo serviço.	String	3	Não
token	Token gerado via API do Deps	String		Não
} ]

Exemplo layout JSON

[
  {
    "tipoCliente": "J",
    "documentoCliente": "12345678901234",
    "nomeOrigem": "Nome",
    "valor": 2205.30,
    "situacao": 0,
    "documentoEmitente": "12345678901234",
    "dataEmissao": "01/01/2019",
    "cmc7": "INTCH00101",
    "numeroCheque": "126552",
    "banco": "Brasil",
    "agencia": "006",
    "contaCorrente": "1554605",
    "dataVencimento": "01/01/02019",
    "tipoCedente": "F",
    "documentoCedente": "123456701234",
    "codigoSistemaGestaoParametrizacaoCategoria": "CDG0032",
    "nomeCategoria": "Categoria 1",
    "nomeEmitente": "Nome Emitente",
    "codigoMoeda": "BRL",
    "token": "token"
  }
]

# Cadastro de Cheque V2

Através dessa integração será possível cadastrar as informações de cheque.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_chequeV2 (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 5 rest Integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
cmc7	Código que não pode ser repetido, sendo assim deve ser único (Caracteres Magnéticos Codificados em 7 Barras).	String	40	Sim
token	Token gerado via API do Deps	String		Não
cheque {
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, 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
valor	Valor do cheque. Exemplo de formato: 1000.00	Decimal	18,2	Sim
situacao	Sistuação do cheque, sendo: 0 - Não compensado 1 - Compensado 2 - Devolvido	Int	1	Sim
documentoEmitente	Documento do emitente do cheque, sendo esse o dono do cheque, onde deve ser enviado um CNPJ ou CPF válido.	String	14	Sim
dataEmissao	Data de emissão do cheque.Formato: dd/MM/aaaa HH:mm:ss	String		Sim
numeroCheque	Número do cheque para controle interno	String	40	Não
banco	Banco do cheque	String	50	Não
agencia	Agência do banco do cheque	String	20	Não
contaCorrente	Conta corrente do cheque	String	15	Não
dataVencimento	Data de vencimento do cheque. Formato: dd/MM/aaaa HH:mm:ss	String		Não
tipoCedente	Tipo do cedente, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoCedente	Documento do cedente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
codigoSistemaGestaoParametrizacaoCategoria	Código da parametrização de categoria no sistema de gestão.	String	50	Não
nomeCategoria	Nome da categoria da parametrização de categoria no sistema de gestão.	String	30	Não
nomeEmitente	Nome do emitente do cheque	String	200	Não
codigoMoeda	Sigla da moeda.Podendo ser BRL, ARS ou USD. Quando enviado na integração a informação diferente de BRL o DepsNet irá buscar a cotação da moeda do dia anterior da data de emissão do cheque e realizado a conversão dos valores do pedido para Reais.Quando não encontrado a cotação do dia anterior da data de emissão do cheque, não será realizado a integração e será retornado uma mensagem pelo serviço.	String	3	Não
}
divisorLimite [ {
Obs.: Esse bloco tem o comportamento de “espelhamento”, mantendo ativos somente os divisores que vieram na última integração, e desassociando os excedentes caso existam.
desassociar	Este campo foi descontinuado por conta do comportamento de espelhamento. Tag foi mantida apenas para evitar erros em integrações ja criadas.	String	1	Não
codigoSistemaGestao	Código identificador do divisor de limite do cheque no sistema de gestão. Obs.: Para a associação do divisor de limite com o cheque, o divisor deve estar parametrizado para a origem do cheque.	String	50	Sim
valor	Valor do divisor de limite para o cheque	Decimal	18,2	Sim
} ]
}

Exemplo layout JSON

[
  {
    "cmc7": "INTCHV24454",
    "token": "token",
    "cheque": {
      "tipoCliente": "F",
      "documentoCliente": "12345678901234",
      "nomeOrigem": "Nome",
      "valor": 6800.30,
      "situacao": 0,
      "documentoEmitente": "12345678901234",
      "dataEmissao": "01/01/2019",
      "numeroCheque": "44515",
      "banco": "Brasil",
      "agencia": "006",
      "contaCorrente": "1255639",
      "dataVencimento": "01/01/2019",
      "tipoCedente": "F",
      "documentoCedente": "123456789012345",
      "codigoSistemaGestaoParametrizacaoCategoria": "CDGSG66523",
      "nomeCategoria": "Categoria V2",
      "nomeEmitente": "Nome Emitente",
      "codigoMoeda": "BRL"
    },
    "divisorLimite": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CDGsg44545",
        "valor": 420.00
      }
    ]
  }
]

# Cadastro de Nota

Através dessa integração será possível cadastrar as informações de nota.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_nota (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 6 Rest Intergacao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
codigo	Código da nota	String	30	Sim
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, 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
tipoRepresentante	Tipo do representante, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoRepresentante	Documento do representante, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
dataEmissao	Data de emissão da nota. Formato: dd/MM/aaaa HH:mm:ss	String		Sim
documentoNota	Documento da nota	String	30	Sim
situacao	Sistuação da nota, sendo: 1 - Faturamento normal 2 - Devolução 3 - Cancelamento	Int		Sim
valor	Valor da nota. Exemplo de formato: 1000.00	Decimal	18,2	Sim
serie	Série da nota	String	10	Não
tipoCedente	Tipo do cedente, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoCedente	Documento do cedente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
codigoMoeda	Sigla da moeda utilizada na nota. Podendo ser BRL, ARS ou USD. Quando enviado na integração a informação diferente de BRL o DepsNet irá buscar a cotação da moeda do dia anterior da data de emissão da nota e realizado a conversão dos valores do pedido para Reais. Quando não encontrado a cotação do dia anterior da data de emissão da nota, não será realizado a integração e será retornado uma mensagem pelo serviço.	String	3	Não
token	Token gerado via API do Deps	String		Não
} ]

Exemplo layout JSON

[
  {
    "codigo": "CDG00121",
    "tipoCliente": "F",
    "documentoCliente": "123456789012345",
    "nomeOrigem": "Nome",
    "tipoRepresentante": "F",
    "documentoRepresentante": "123456789011112",
    "dataEmissao": "01/01/2019",
    "documentoNota": "5546003",
    "situacao": 1,
    "valor": 1015.45,
    "serie": "1A",
    "tipoCedente": "J",
    "documentoCedente": "1234577780",
    "codigoMoeda": "CDGNOT00012",
    "token": "token"
  }
]

# Cadastro de Nota Complementar

Através dessa integração será possível cadastrar as informações de nota complementar.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_notacomplementar (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 7 Rest Integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
codigo	Código da nota complementar	String	30	Sim
token	Token gerado via API do Deps	String		Não
notaComplementar {
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, 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
dataEmissao	Data de emissão da nota complementar. Formato: dd/MM/aaaa HH:mm:ss	String		Sim
documentoNotaComplementar	Documento da nota complementar	String	30	Sim
tipo	Tipo da nota complementar, sendo: 1 - Crédito 2 - Débito	Int		Sim
valor	Valor da nota complementar. Exemplo de formato: 1000.00	Decimal	18,2	Sim
saldo	Saldo da nota complementar	Decimal	18,2	Não
codigoNota	Código da nota fiscal	String	30	Não
tipoCedente	Tipo do cedente, sendo: J - Jurídica F - Física E - Exportação	String	1	Não
documentoCedente	Documento do cedente, sendo: - CNPJ quando for pessoa jurídica - CPF quando for pessoa física - Código identificador para tipo Exportação	String	15	Não
codigoMoeda	Sigla da moeda utilizada na nota complementar. Podendo ser BRL, ARS ou USD. Quando enviado na integração a informação diferente de BRL o DepsNet irá buscar a cotação da moeda do dia anterior da data de emissão da nota complementar e realizado a conversão dos valores do pedido para Reais.Quando não encontrado a cotação do dia anterior da data de emissão da nota complementar, não será realizado a integração e será retornado uma mensagem pelo serviço.	String	3	Não
}
divisorLimite [ {
Obs.: Esse bloco tem o comportamento de “espelhamento”, mantendo ativos somente os divisores que vieram na última integração, e desassociando os excedentes caso existam.
desassociar	Este campo foi descontinuado por conta do comportamento de espelhamento. Tag foi mantida apenas para evitar erros em integrações ja criadas.	String	1	Não
codigoSistemaGestao	Código identificador do divisor de limite da nota complementar no sistema de gestão. Obs.: Para a associação do divisor de limite com o nota complementar, o divisor deve estar parametrizado para a origem da nota complementar.	String	50	Sim
valor	Valor do divisor de limite para a nota complementar	Decimal	18,2	Sim
} ]
parametrizacoesCategorias [ {
codigoSistemaGestao	Código identificador da parametrização da categoria da nota complementar no sistema de gestão. A associação irá respeitar a parametrização do sistema: "Desassociar ao associar param. de categorias". Onde conforme opção definida, a nota complementar poderá ou não ter mais de uma parametrização de categoria da mesma categoria. Obs.: Essa parametrização pode ser acessada através da opção: Configurações / Config. Gerais / Param. do Sistema do DepsNet.	String	50	Sim
nomeCategoria	Nome da categoria da nota complementar no sistema de gestão.	String	30	Não
desassociar	Para desassociar a parametrização de categoria do título deve ser enviado "S". Caso contrário deve ser enviado em branco. Obs.: Qualquer informação diferente de "S" para esse campo, o mesmo será considerado como um cadastro no DepsNet	String	1	Não
nome	Nome da parametrização da categoria da nota complementar no sistema de gestão.	String	100	Não
} ]
} ]

Exemplo layout JSON

[
  {
    "codigo": "CDG44511",
    "token": "token",
    "notaComplementar": {
      "tipoCliente": "J",
      "documentoCliente": "12345678901234",
      "nomeOrigem": "Nome",
      "dataEmissao": "01/01/2019",
      "documentoNotaComplementar": "DOCNOT54545",
      "tipo": 2,
      "valor": 6975.30,
      "saldo": 300.00,
      "codigoNota": "CDGNOT662",
      "tipoCedente": "F",
      "documentoCedente": "123456781515",
      "codigoMoeda": "BRL"
    },
    "divisorLimite": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CD00323",
        "valor": 560.50
      }
    ],
    "parametrizacoesCategorias": [
      {
        "desassociar": "",
        "codigoSistemaGestao": "CDG00655",
        "nomeCategoria": "Portador",
        "nome": "João"
      }
    ]
  }
]

# Cadastros Complementares

Através dessa integração será possível cadastrar as informações complementares para pessoa, pedidos e contas a receber. Abaixo segue os cadastros disponíveis:

Pessoa
- Bloqueio
- Grupo Econômico
- Grupo Informação Cadastral
- SubGrupo Informação Cadastral
- Informação Cadastral
Pedido
- Motivo
- Situação
- Parametrização Motivo Situação
- Categoria
- Parametrização Categoria
- Segmento Produto
- Grupo Produto
- Item Produto
Contas a Receber
- Categoria
- Parametrização Categoria
Origem
Ponto de aderência

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_CadastrosComplementares (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 8 rest integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
{
token	Token gerado via API do Deps	String		Não
pessoa {
bloqueios [ {
codigo	Código do bloqueio	String	10	Sim
nome	Nome do bloqueio	String	60	Sim
tipoValidacao	Tipo da validação do bloqueio, sendo: 1 - Bloqueio será aplicado para todos da raiz 2 - Bloqueio será aplicado somente para o CNPJ 3 - Bloqueio será aplicado para todos do Grupo	Int		Sim
nomeOrigem	Nome da origem de informação cadastral	String	40	Sim
} ]
gruposEconomicos [ {
codigoSistemaGestao	Código identificador do grupo econômico no sistema de gestão	String	50	Sim
nome	Nome do grupo econômico	String	100	Sim
nomeOrigem	Nome da origem de informação cadastral	String	40	Sim
} ]
gruposInformacoesCadastrais [ {
Nome	Nome do grupo de informação cadastral	String	40	Sim
} ]
subGruposInformacoesCadastrais [ {
codigoSistemaGestao	Código identificador do subgrupo de informação cadastral no sistema de gestão	String	50	Sim
nome	Nome do subgrupo de informação cadastral	String	40	Sim
nomeGrupo	Nome do grupo de informação cadastral	String	40	Sim
} ]
informacoesCadastrais [ {
codigoSistemaGestao	Código identificador da informação cadastral no sistema de gestão	String	50	Sim
nome	Nome da informação cadastral	String	200	Sim
codigoSistemaGestaoSubgrupoInformacaoCadastral	Código identificador do subgrupo de informação cadastral no sistema de gestão	String	50	Sim
nomeOrigem	Nome da origem de informação cadastral	String	40	Sim
} ]
}
pedido {
motivos [ {
codigoSistemaGestao	Código identificador do motivo no sistema de gestão	String	50	Sim
nome	Nome do motivo	String	50	Sim
} ]
situacoes [ {
codigoSistemaGestao	Código identificador da situação no sistema de gestão Código sistema de gestão passou a ser obrigatório a partir da versão v21_8 do DepsNet, por conta de implementação de chave única dessa informação no banco de dados. Clientes antigos que não utilizavam este campo não devem ser afetados.	String	50	Sim*
nome	Nome da situação	String	50	Sim
condicao	Condição da situação, sendo: 0 - Não toma crédito (quando o pedido estiver com esta situação deve ser descontado o valor do limite disponível) 1 - Toma crédito (quando o pedido estiver com esta situação não deve ser descontado valor) Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
tipo	Tipo da situação, sendo: 0 - Nenhum 1 - Aprovado 2 - Bloqueado 3 - Faturado Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
contaAutomacao	Conta automação, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
utilizaAlcadaReanalise	Utiliza alçada reanálise, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
permiteMultiplosMotivos	Permitir mais de um motivo, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
obrigatoriedadeMotivo	Obrigatoriedade de informar motivo, sendo: 0 - Sem obrigação 1 - Apenas motivo obrigatório 2 - Apenas informação complementar obrigatório 3 - Motivo ou informação complementar obrigatório Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
} ]
parametrizacoesMotivosSituacoes [ {
codigoSistemaGestaoMotivo	Código identificador do motivo no sistema de gestão	String	50	Sim
codigoSistemaGestaoSituacao	Código identificador da situação no sistema de gestão	String	50	Sim
desassociar	Para desassociar a parametrização de motivo com situação enviar "S", caso contrário enviar em branco.	String	1	Não
} ]
categorias [ {
nome	Nome da categoria	String	50	Sim
} ]
parametrizacoesCategorias [ {
codigoSistemaGestao	Código identificador da parametrização de categoria no sistema de gestão	String	50	Sim
nome	Nome da parametrização de categoria	String	100	Sim
nomeCategoria	Nome da categoria	String	50	Sim
aprovadoAutomacao	O pedido pode ter sua situação alterada para aprovado pela automação, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
bloqueadoAutomacao	O pedido pode ter sua situação alterada para bloqueado pela automação, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
} ]
segmentosProdutos [ {
codigoSistemaGestao	Código identificador do segmento de produto no sistema de gestão	String	50	Sim
Nome	Nome do segmento de produto	String	50	Sim
nomeOrigem	Nome da origem de informação cadastral	String	40	Sim
} ]
gruposProdutos [ {
codigoSistemaGestao	Código do grupo de produto no sistema de gestão	String	50	Sim
nome	Nome do grupo de produto	String	50	Sim
codigoSistemaGestaoSegmentoProduto	Código identificador do segmento de produto no sistema de gestão	String	50	Sim
} ]
itensProdutos [ {
codigoSistemaGestao	Código do item de produto no sistema de gestão	String	50	Sim
nome	Nome do item de produto	String	100	Sim
codigoSistemaGestaoGrupoProduto	Código identificador do grupo de produto no sistema de gestão	String	50	Sim
} ]
}
contaReceber {
categorias [ {
nome	Nome da categoria	String	30	Sim
} ]
parametrizacoesCategorias [ {
codigoSistemaGestao	Código da parametrização de categoria no sistema de gestão	String	50	Sim
nome	Nome da parametrização de categoria	String	100	Sim
nomeCategoria	Nome da categoria	String	30	Sim
contaInadimplencia	Conta inadimplência, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
contaPagamento	Conta pagamento, sendo: 0 - Não 1 - Sim Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Não
tipoRelacionamento	Tipo relacionamento, sendo: 1 - Título 2 - Cheque 3 - Nota complementar Obs.: Parametrização disponível somente para registro de Inclusão. Para registro de Alteração a informação enviada será desconsiderada.	Int		Sim
} ]
}
origem {
nomeOrigem	Nome da origem	String	40	Sim
}
pontoAderencia [{
codigoPolitica	Código da política	Int		Sim
codigoSistemaGestaoInformacaoCadastral	Código da informação cadastral no sistema de gestão	String		Sim
combinado	Combinado, sendo: 0 - Não 1 - Sim	Int		Sim
nomeOrigem	Nome da origem	String		Sim
}]
}

Exemplo layout JSON

{
  "token": "token",
  "pessoa": {
    "bloqueios": [
      {
        "codigo": "CDG8080",
        "nome": "Nome do bloqueio",
        "tipoValidacao": 1,
        "nomeOrigem": "Nome origem"
      }
    ],
    "gruposEconomicos": [
      {
        "codigoSistemaGestao": "CDG003",
        "nome": "Nome do grupo economico",
        "nomeOrigem": "Nome origem"
      }
    ],
    "gruposInformacoesCadastrais": [
      {
        "nome": "Nome do grupo de informações"
      }
    ],
    "subGruposInformacoesCadastrais": [
      {
        "codigoSistemaGestao": "CDG451",
        "nome": "Nome origem",
        "nomeGrupo": "Nome do grupo de informações"
      }
    ],
    "informacoesCadastrais": [
      {
        "codigoSistemaGestao": "CDG784",
        "nome": "Nome",
        "codigoSistemaGestaoSubgrupoInformacaoCadastral": "CDG0035",
        "nomeOrigem": "Nome da origem informações"
      }
    ]
  },
  "pedido": {
    "motivos": [
      {
        "codigoSistemaGestao": "cdgmotv454",
        "nome": "Nome do motivo"
      }
    ],
    "situacoes": [
      {
        "codigoSistemaGestao": "CDGSIT8898",
        "nome": "Nome da situacao",
        "condicao": 1,
        "tipo": 2,
        "contaAutomacao": 1,
        "utilizaAlcadaReanalise": 0,
        "permiteMultiplosMotivos": 0,
        "obrigatoriedadeMotivo": 0
      }
    ],
    "parametrizacoesMotivosSituacoes": [
      {
        "codigoSistemaGestaoMotivo": "CDGMOTIV44545",
        "codigoSistemaGestaoSituacao": "CDGMOTV0322",
        "contaAutomacao": 0,
        "desassociar": ""
      }
    ],
    "parametrizacoesCategorias": [
      {
        "codigoSistemaGestao": "CDGsg2254",
        "nome": "Nome da parametrizacao",
        "nomeCategoria": "Nome categoria",
        "aprovadoAutomacao": 0,
        "bloqueadoAutomacao": 0
      }
    ],
    "categorias": [
      {
        "nome": "Nome da categoria"
      }
    ],
    "segmentosProdutos": [
      {
        "codigoSistemaGestao": "CDG0032",
        "nome": "Nome do Segmento",
        "nomeOrigem": "Nome Origem"
      }
    ],
    "gruposProdutos": [
      {
        "codigoSistemaGestao": "CDG003",
        "nome": "Nome do grupo produto",
        "codigoSistemaGestaoSegmentoProduto": "CDG002124"
      }
    ],
    "itensProdutos": [
      {
        "codigoSistemaGestao": "CDG4541",
        "nome": "Nome item produto",
        "codigoSistemaGestaoGrupoProduto": "CDG10214"
      }
    ]
  },
  "contaReceber": {
    "categorias": [
      {
        "nome": "Nome da categoria"
      }
    ],
    "parametrizacoesCategorias": [
      {
        "codigoSistemaGestao": "CDG45451",
        "nome": "Nome da parametrização",
        "nomeCategoria": "Nome da categoria",
        "contaInadimplencia": 1,
        "contaPagamento": 1,
        "tipoRelacionamento": 2
      }
    ]
  },
  "origem": {
    "nomeOrigem": "Nome da origem"
  },
  "pontosAderencia": [
    {
      "codigoPolitica": 0,
      "codigoSistemaGestaoInformacaoCadastral": "CDG5562",
      "combinado": 0,
      "nomeOrigem": "Nome da origem"
    }
  ],
  "consultaOpcoesUsuario": {    !!!!!!!!!!!!!!nao tem na tabela
    "codigo": 0,
    "nomeConsulta": "string",
    "nome": "string",
    "codigoProvedor": "string"
  }
}

# Cadastro de Balanço

Através dessa integração será possível cadastrar as informações de balanço.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_balanco (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 9 REST Integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
tipoCliente	Tipo do cliente, sendo apenas: J - Jurídica E - Exportação	String	1	Sim
documentoCliente	Documento do cliente, sendo: - CNPJ quando for pessoa jurídica - Código identificador para tipo Exportação	String	15	Sim
token	Token gerado via API do Deps	String		Não
itemsBalanco [ {
anoExercicio	Ano exercício na qual se refere o balanço informado, com 4 dígitos.	Int	4	Sim
periodoAnalise	Período de análise que será utilizado no balanço em meses. Valor máximo de 12 meses	Int	2	Sim
clientes	Valor de clientes.	Decimal	18,2	Sim
ativoCirculante	Valor de ativo circulante	Decimal	18,2	Sim
ativoTotal	Valor de ativo total	Decimal	18,2	Sim
fornecedores	Valor de fornecedores	Decimal	18,2	Sim
emprestimosFinanciamentosCP	Valor de empréstimos financiamentos CP	Decimal	18,2	Sim
passivoCirculante	Valor de passivo circulante	Decimal	18,2	Sim
emprestimosFinanciamentosLP	Valor de empréstimos financiamentos LP	Decimal	18,2	Sim
passivoNaoCirculante	Valor de passivo não circulante	Decimal	18,2	Sim
capitalSocial	Valor de capital social	Decimal	18,2	Sim
pl	Valor de PL	Decimal	18,2	Sim
passivoTotal	Valor de passivo total	Decimal	18,2	Sim
receitaBruta	Valor de receita bruta	Decimal	18,2	Sim
cmv	Valor de CMV	Decimal	18,2	Sim
receitaLiquida	Valor de receita líquida	Decimal	18,2	Sim
lucroOperacional	Valor de lucro operacional	Decimal	18,2	Sim
lucroLiquido	Valor de lucro líquido	Decimal	18,2	Sim
estoque	Valor do estoque	Decimal	18,2	Não
depreciacaoAmortizacao	Valor de depreciação e amortização	Decimal	18,2	Não
passivoExigivelLP	Valor passivo exigível	Decimal	18,2	Não
realizavelLongoPrazo	Valor realizável a longo prazo	Decimal	18,2	Não
} ]
} ]

Exemplo layout JSON

[
  {
    "tipoCliente": "J",
    "documentoCliente": "12345678901234",
    "token": "token",
    "itemsBalanco": [
      {
        "anoExercicio": 2016,
        "periodoAnalise": 12,
        "clientes": 30,
        "ativoCirculante": 62.30,
        "ativoTotal": 300.00,
        "fornecedores": 54.50,
        "emprestimosFinanciamentosCP": 60.0,
        "passivoCirculante": 12.10,
        "emprestimosFinanciamentosLP": 36.20,
        "passivoNaoCirculante": 55.20,
        "capitalSocial": 90.60,
        "pl": 54.80,
        "passivoTotal": 150.5,
        "receitaBruta": 930.45,
        "cmv": 10.6,
        "receitaLiquida": 80.60,
        "lucroOperacional": 145.6,
        "lucroLiquido": 1660.10,
        "estoque": 9050.10,
        "depreciacaoAmortizacao": 200.30,
        "passivoExigivelLP": 60.4,
        "realizavelLongoPrazo": 450.3
      }
    ]
  }
]

# Cadastro de Cotação de Moeda

Através dessa integração será possível cadastrar as informações de cotação de moeda.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_CotacaoMoeda (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 10 rest integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
moedaDe	Moeda de origem da cotação	String	3	Sim
moedaPara	Moeda de destino da cotação	String	3	Sim
valor	Valor da cotação	Decimal	18,7	Sim
data	Data da cotação	String	10	Sim
token	Token gerado via API do Deps	String		Não
} ]

Exemplo layout JSON

[
  {
    "moedaDe": "BRL",
    "moedaPara": "USD",
    "valor": "560.60",
    "data": "01/01/2019",
    "token": "token"
  }
]

# Cadastro de Informação Blacklist

Através dessa integração será possível cadastrar as informações na Blacklist.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_Blacklist (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 11 rest integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
token	Token gerado via API do Deps	String		Não
pessoa {
nome	Nome da pessoa	String	200	Não
razaoSocial	Razão social de pessoa jurídica.	String	200	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
}
contato {
telefone	Telefone do contato.	String	25	Não
email	E-mail do contato.	String	200	Não
}
endereco {
nomeCidade	Nome da cidade do endereço	String	50	Sim*
uf	Unidade federativa do endereço.	String	2	Sim*
bairro	Nome do bairro.	String	100	Sim*
cep	Código de endereço postal do logradouro.	String	10	Sim*
complemento	Complemento do logradouro.	String	80	Não
rua	Nome da rua.	String	200	Sim*
numero	Número do logradouro.	String	15	Sim*
}
registroProfissional {
tipoRegistroProfissional	Tipo de registro profissional.Tipos presentes no DepsNet: CRO, CRMV, ANVISA	String	30	Sim*
ufRegistroProfissional	Unidade federativa do registro profissional.	String	2	Sim*
codigoRegistroProfissional	Código referente ao Registro profissional	String	30	Sim*
}
} ]

Observações

Para integração de endereço ou dados profissionais devem ser enviadas todas as informações obrigatórias, o não cumprimento dessa regra não impedirá a integração de outras informações não relacionadas.

As informações de endereço serão concatenadas e salvas como uma única informação na base de dados da blacklist, informação de registro profissional seguirá o mesmo comportamento.

Caso o tipo de registro profissional esteja parametrizado no DepsNet para não receber Uf, caso esta seja enviada, será desconsiderada.

Segue o layout final das informações concatenadas.

Endereço: "Rua, Número, Complemento, Cep, Bairro, Cidade/Uf"
Registro profissional: "Uf-Tipo-Código"

Exemplo layout JSON

[
  {
    "token": "token",
    "pessoa": {
      "nome": "Nome fantasia teste",
      "razaoSocial": "Razão social teste",
      "documento": "11100011133"
    },
	"contato": {
      "telefone": "48999009988",
      "email": "[email protected]"
    },
    "endereco": {
      "nomeCidade": "Criciuma",
      "uf": "SC",
      "bairro": "Centro",
      "cep": "88816000",
      "complemento": "Loja 1",
      "rua": "Joaquin Lacerda",
      "numero": "150"
    },
    "registroProfissional": {
      "tipoRegistroProfissional": "CRO",
      "ufRegistroProfissional": "SC",
      "codigoRegistroProfissional": "xxx00"
    }
  }
]

# Cadastro de Frotista Transportadora

Através dessa integração será possível cadastrar frotas, veículos de transportadora ou de passeio.

Para consultar a estrutura dessa integração deve ser acessado a URL http://localhost:74/swagger/ui/index#!/Integracoes/Integracoes_FrotistaTransportadora (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 13 rest integracao

Segue abaixo documentação referente a cada campo disponibilizado nessa integração, onde os campos estão organizados conforme os blocos de informações disponibilizados para esta integração.

Campo	Descrição	Tipo	Tam.	Obr.
[ {
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
tipoCliente	Tipo do cliente, sendo: J - Jurídica F - Física E - Exportação	String	1	Sim
tipoRelacionamento	Tipo de relacionamento da pessoa, sendo: C - Cliente R - Representante	String	1	Sim
nomeOrigem	Nome da origem de informação cadastral	String	40	Sim
token	Token gerado via API do Deps	String		Não
tipoProprietario	Tipo de proprietário, sendo: Frotista Transportadora Passeio	String	40	Sim*
frotistaTransportadora [ {
tipoVeiculo	Tipo de veículo	String	40	Sim
ano	Ano do veículo ou frota	String	50	Sim*
dataConfirmacao	Data para o vencimento da confirmação da informação Formato: dd/MM/aaaa	dateTime		Sim*
dias	Dias para o vencimento da confirmação da informação	Int		Sim*
quantidade	Quantidade da frota	Int		Sim*
placa	Placa do veículo	String	7	Sim*
renavan	Renavan do veículo	String	11	Sim*
} ]
} ]

Observações

1 - Quando o tipo proprietário for Frotista os campos placa e renavan não serão obrigatórios.
2 - Poderá ser enviado a data de confirmação ou os dias, ao ser enviado as duas informações a data terá preferencia.
3 - Quando o tipo proprietário for transportadora ou passeio, o campo quantidade não será obrigatório.
4 - Ao integrar uma informação com o tipo de proprietário diferente do que já está cadastrado para o cliente, toda as informações do antigo tipo de proprietário serão perdidas. 5 - O tipoProprietario só será obrigatório quando houver informações na lista frotistaTransportadora.

Exemplo layout JSON

[
  {
    "documento": "01234567000100",
    "tipoCliente": "J",
    "tipoRelacionamento": "C",
    "nomeOrigem": "Sistema de gestão",
    "token": "token",
    "tipoProprietario": "Transportadora",
    "frotistaTransportadora": [
      {
        "tipoVeiculo": "Trator",
        "ano": "1997",
        "dataConfirmacao": "10/10/2024",
        "dias": 0,
        "quantidade": 0,
        "placa": "TRT1A22",
        "renavan": "12389712312"
      }
    ]
  }
]

← Consulta Dados Requisições →