Introdução
A API Cedrus tem como objetivo integrar o sistema de cobrança Cedrus com seu software de gestão empresarial. Através dessa API, permitimos que você
envie sua lista de devedores e títulos inadimplentes para nossa plataforma sem a intervenção manual de um operador.
Dependendo da estrutura do seu software de gestão, é necessário desenvolver uma rotina específica nele para poder consumir nossas APIs. Para saber isso,
entre em contato com seu fornecedor de software e verifique essa possibilidade de integração.
Suporte Técnico
Temos um time de suporte dedicado a resolver todas as suas dúvidas e dificuldades técnicas durante a integração. Para isso, entre em contato através do email:
suporte@rdz.com.br
Conceitos Básicos
Para fazer a comunicação, nossos endpoints utilizam o formato JSON. Utilizamos o princípio REST, que é simples de integrar, eficiente e seguro
e também uma APIKEY para autenticação e proteção dos dados.
A URL base para fazer as chamadas é: https://api.sistemadecobranca.com.br:3001/v1/
Autenticação
A autenticação nas chamdas dos serviços é feita através da utilização de uma APIKEY. Para obter essa key, entre em contato com o suporte pelo email
suporte@rdz.com.br e solicite a APIKEY da sua empresa.
A maneira de se autenticar é utilizando basic access authentication. Envie sua API Key como username da autenticação básica
sem necessidade de nenhuma password (senha).
A conexão com a API é encriptada e autenticada usando a TLS 1.3.
Erros
A API retorna Códigos de Status HTTP para indicar sucesso ou falha durante a chamada.
Em geral, os códigos iniciados com:
- 2xx indicam sucesso;
- 4xx indicam erro (Ex: Falta de parâmetro obrigatório ou Falha ao autenticar);
- 5xx indicam erro interno nos serviços do Gateway.
Alguns métodos incluem outros retornos, portanto, consulte sempre o resultado do método utilizado.
| Status |
Mensagem |
Descrição |
| 200 |
Sucesso |
Método invocado executou com sucesso. |
| 401 |
Falha ao autenticar |
Verifique sua API |
| 403 |
Não autorizado |
|
| 500 |
Erro interno |
Ocorreu uma instabilidade no Gateway, tente novamente em alguns segundos ou acione nosso suporte. |
Consultar Devedor
Utilize esse endpoint para consultar os dados dos devedores no banco de dados.
Para listar os devedores, basta realizar um GET para o endereço abaixo.
Você pode filtrar os dados que serão retornados para você enviando um JSON no corpo da requisição.
As opções de filtro estão listadas em "Body Params" logo a seguir.
Campos obrigatórios para consulta: id_devedor ou cod_credor/cod_devedor.
GET https://api.sistemadecobranca.com.br:3001/v1/devedor
Accept: application/json
Content-Type: application/json
Body Params (Filtro dos dados)
id_devedor
Código identificador do Devedor, retornado pela API na criação do devedor (Inserir devedor)
cod_credor
Código do Credor
cod_devedor
Código do Devedor
status
Status do título ("A"=Aberto / "P"=Pago / "C"=Cancelado / "S"=Suspenso)
dt_vencimento_de
Data de vencimento inicial do título (formato: dd/mm/yyyy)
dt_vencimento_ate
Data de vencimento final do título (formato: dd/mm/yyyy)
num_pagina
Número da página a ser retornada
// Exemplo de JSON
{
"id_devedor":"000000-0000000000000",
"cod_credor":"000",
"cod_cliente":"11111111",
"status":"A",
"dt_vencimento_de":"01/01/2022",
"dt_vencimento_ate":"31/01/2022",
"num_pagina":"1"
}
Campos devolvidos no response
id_devedor
Código identificador do Devedor, retornado pela API na criação do devedor (Inserir devedor)
cod_credor
Código do Credor
cod_devedor
Código do Devedor
nome
Nome
tp_pessoa
Tipo de pessoa ("F"= Pessoa Física / "J"= Pessoa Juridica)
cnpj_cpf
CNPJ/CPF do Devedor
email
E-mail
endereco
Endereço
numero
Número do endereço
complemento
Complemento do endereço
bairro
Bairro
cidade
Cidade
estado
Estado
cep
Cep
dado adicional
Dado adicional
(+)Telefones
Telefone do Devedor
fone
Telefone do Devedor
fone_obs
Observação do Telefone do Devedor
fone_status
Status do Telefone do Devedor (valido /inválido)
(+)Títulos
Títulos do Devedor
id_titulo
Código identificador do título, retornado pela API na criação do título (Inserir Título)
cod_titulo
Código do título
parcela
Número da Parcela
status
Status do título ("A"=Aberto / "P"=Pago / "C"=Cancelado / "S"=Suspenso)
dt_vencimento
Data de vendimento do título (formato: dd/mm/yyyy)
dt_programada
Data programada do título (formato: dd/mm/yyyy)
vl_titulo
Valor do Título. Ex: 1.500,00
vl_saldo
Valor do saldo devedor. Ex: 1.500,00
dt_atualizacao
Data de atualização do saldo do título (formato: dd/mm/yyyy)
vl_atualizado
Valor atualizado do título (formato: dd/mm/yyyy)
portador
Portador
nosso_numero
Nosso número do título
linha_digitavel
Linha Digitável do Boleto
cod_barra
Código de barras do Boleto
link_boleto
URL onde o cliente pode visualizar ou fazer o download do boleto
dt_pagamento
Data de pagamento do título (formato: dd/mm/yyyy)
dt_credito
Data de crédito do título (formato: dd/mm/yyyy)
vl_pago
Valor pago. Ex: 1.500,00
tipo_titulo
Tipo do título. Onde:
Original: Titulo original de uma dívida do devedor com o credor
Negociação: Titulo oriundo de um acordo ou negociação de titulo original
// Exemplo de JSON devolvido
{
"id_devedor":"000000-0000000000000",
"cod_credor":"000",
"cod_devedor":"11111111",
"nome":"MARIA DE LOURDES DOMINGUES DA SILVA",
"tp_pessoa":"F",
"cnpj_cpf":"11111111111",
"email":"maria@gmail.com",
"endereco":"RUA SAO JOAO BATISTA",
"numero":"25",
"complemento":"CS 1",
"bairro":"BOTAFOGO",
"cidade":"RIO DE JANEIRO",
"estado":"RJ",
"cep":"00000000",
"dado_adicional":"Cliente VIP",
"telefones":[
{
"fone":"1199999999"
},
{
"fone":"1199999999",
"fone_observacao":"recado",
"fone_status":"valido"
},
{
"fone":"21999999999"
},
{
"fone":"21999999999"
}
],
"titulos":[
{
"id_titulo":"000000-0000000000000",
"cod_titulo":"111111/1",
"parcela":"1",
"status":"N",
"dt_vencimento":"22/09/2014",
"dt_programada":"22/09/2014",
"vl_titulo":"563,18",
"vl_saldo":"563,18",
"dt_atualizacao":"22/09/2021",
"vl_atualizado":"620,52",
"portador":"BRADESCO",
"nosso_numero":"000000009277",
"linha_digitavel":"23792.84405 20000.000099 27000.285406 4 44160000032475",
"cod_barra":"23794441600000324752844020000000092700028540",
"link_boleto":"",
"dt_pagto":"01/10/2021",
"dt_credito":"01/10/2021",
"vl_pago":"625,00",
"tipo_titulo":"Original"
}
]
}
Inserir Devedor
Insere os dados de um novo devedor no banco de dados.
POST https://api.sistemadecobranca.com.br:3001/v1/devedor
Accept: application/json
Content-Type: application/json
Body Params
cod_credor
Código do credor
cod_devedor
Código do devedor
nome
Nome do devedor
tp_pessoa
Tipo de pessoa: "F" = Física ou "J" = Jurídica
cnpj_cpf
CNPJ ou CPF do devedor
ie_rg
Inscrição estadual (se pessoal jurídica) ou RG (se pessoa física)
dt_nascimento
Data de nascimento do devedor (formato: dd/mm/yyyy)
nome_mae
Nome da mãe do devedor
categoria
Categoria do devedor
gerente
Gerente responsável pelo devedor
score
Score do devedor
fone_1
Telefone de contato 1
fone_2
Telefone de contato 2
fone_3
Telefone de contato 3
email
Email do devedor
endereco
Endereço do devedor
end_numero
Número de endereço
end_complemento
Complemento
bairro
Bairro
cidade
Cidade
estado
Estado (UF)
cep
CEP
dado_adicional
Dados adicionais
// Exemplo de JSON
{
"cod_credor":"MAX",
"cod_devedor":"1744",
"nome":"Max Material Contra Incêndio",
"tp_pessoa":"J",
"cnpj_cpf":"88.510.373/0001-00",
"ie_rg":"000.000.000.000",
"dt_nascimento": "10/05/1975",
"nome_mae": ""
"categoria":"PADRAO",
"gerente": "José",
"score":"0",
"fone_1":"(11) 0000-0000",
"fone_2":"(11) 9 0000-0000",
"fone_3":"",
"email":"max@rdz.com.br",
"endereco":"Rua Kappel",
"end_numero":"985",
"end_complemento": "",
"bairro":"Centro",
"cidade":"Porto Alegre",
"estado":"RS",
"cep":"14451000",
"dado_adicional": "Contrato ABC123"
}
Campos devolvidos no response
id_devedor
Código identificador do devedor
// Exemplo de JSON retornado
{
"id_devedor":"009900-0000023854455"
}
Alterar Devedor
Altera os dados de um devedor já existente no banco de dados. O identificador de qual devedor deve ser alterado é enviado na URL da requisição:
PUT https://api.sistemadecobranca.com.br:3001/v1/devedor/{id_devedor}
Accept: application/json
Content-Type: application/json
Body Params
cod_credor
Código do credor
cod_devedor
Código do devedor
nome
Nome do devedor
tp_pessoa
Tipo de pessoa: "F" = Física ou "J" = Jurídica
cnpj_cpf
CNPJ ou CPF do devedor
ie_rg
Inscrição estadual (se pessoal jurídica) ou RG (se pessoa física)
dt_nascimento
Data de nascimento do devedor (formato: dd/mm/yyyy)
nome_mae
Nome da mãe do devedor
categoria
Categoria do devedor
gerente
Gerente responsável pelo devedor
score
Score do devedor
fone_1
Telefone de contato 1
fone_2
Telefone de contato 2
fone_3
Telefone de contato 3
email
Email do devedor
endereco
Endereço do devedor
end_numero
Número de endereço
end_complemento
Complemento
bairro
Bairro
cidade
Cidade
estado
Estado (UF)
cep
CEP
dado_adicional
Dados adicionais
// Exemplo de JSON
{
"cod_credor":"MAX",
"cod_devedor":"1744",
"nome":"Max Material Contra Incêndio",
"tp_pessoa":"J",
"cnpj_cpf":"88.510.373/0001-00",
"ie_rg":"000.000.000.000",
"dt_nascimento": "10/05/1975",
"nome_mae": ""
"categoria":"PADRAO",
"gerente": "José",
"score":"0",
"fone_1":"(11) 0000-0000",
"fone_2":"(11) 9 0000-0000",
"fone_3":"",
"email":"max@rdz.com.br",
"endereco":"Rua Kappel",
"end_numero":"985",
"end_complemento": "",
"bairro":"Centro",
"cidade":"Porto Alegre",
"estado":"RS",
"cep":"14451000",
"dado_adicional": "Contrato ABC123"
}
Campos devolvidos no response
id_devedor
Código identificador do devedor
// Exemplo de JSON retornado
{
"id_devedor":"009900-0000023854455"
}
Consultar Titulo
Utilize esse endpoint para consultar os dados dos títulos no banco de dados.
Para listar os títulos, basta realizar um GET para o endereço abaixo.
Você pode filtrar os dados que serão retornados para você enviando um JSON no corpo da requisição.
As opções de filtro estão listadas em "Body Params" logo a seguir.
Você poderá controlar a sua consulta por paginação. Serão enviados 50 registros por página em cada consulta.
Para receber todos os registros, o serviço deve ser chamado várias vezes e a cada chamada o número da página deverá ser incrementado.
Você terá recebido todos os registros quando receber uma mensagem de erro (nenhum registro encontrado).
GET https://api.sistemadecobranca.com.br:3001/v1/titulo
Accept: application/json
Content-Type: application/json
Body Params (Filtro dos dados)
id_devedor
Código identificador do Devedor, retornado pela API na criação do devedor (Inserir devedor)
id_titulo
Código identificador do título, retornado pela API na criação do título (Inserir Título)
cod_credor
Código do Credor
cod_cliente
Código do Devedor
cnpj_cpf
CNPJ/CPF do Devedor
cod_titulo
Código do título
parcela
Número da Parcela
status
Status do título ("A"=Aberto / "P"=Pago / "C"=Cancelado / "S"=Suspenso)
dt_vencimento_de
Data de vencimento inicial do título (formato: dd/mm/yyyy)
dt_vencimento_ate
Data de vencimento final do título (formato: dd/mm/yyyy)
num_pagina
Número da página a ser retornada. Será considerado página 1, se a página não for informada.
Ex.: Página 1 - Registro 1 ao 10, Página 2 - Registro 11 ao 20.
// Exemplo de JSON
{
"id_devedor":"000000-0000000000000",
"id_titulo":"000000-0000000000000",
"cod_credor":"000",
"cod_cliente":"11111111",
"cnpj_cpf":"11111111111",
"cod_titulo":"111111/1",
"parcela":"1",
"status":"A",
"dt_vencimento_de":"01/01/2022",
"dt_vencimento_ate":"31/01/2022",
"num_pagina":"1"
}
Campos devolvidos no response
id_devedor
Código identificador do Devedor, retornado pela API na criação do devedor (Inserir devedor)
cod_credor
Código do Credor
cod_devedor
Código do Devedor
nome
Nome
tp_pessoa
Tipo de pessoa ("F"= Pessoa Física / "J"= Pessoa Juridica)
cnpj_cpf
CNPJ/CPF do Devedor
email
E-mail
endereco
Endereço
numero
Número do endereço
complemento
Complemento do endereço
bairro
Bairro
cidade
Cidade
estado
Estado
cep
Cep
dado adicional
Dado adicional
(+)Telefones
Telefones do Devedor
fone
Telefone do Devedor
fone_obs
Observação do Telefone do Devedor
fone_status
Status do Telefone do Devedor (valido /inválido)
(+)Títulos
Títulos do Devedor
id_titulo
Código identificador do título, retornado pela API na criação do título (Inserir Título)
cod_titulo
Código do título
parcela
Número da Parcela
status
Status do título ("A"=Aberto / "P"=Pago / "C"=Cancelado / "S"=Suspenso)
id_negociacao_titulo
Código da negociação em que o titulo foi negociado (após status = 'N')
dt_vencimento
Data de vencimento do título (formato: dd/mm/yyyy)
dt_programada
Data programada do título (formato: dd/mm/yyyy)
vl_titulo
Valor do Título. Ex: 1.500,00
vl_saldo
Valor do saldo devedor. Ex: 1.500,00
dt_atualizacao
Data da atualização do valor do título (formato: dd/mm/yyyy)
vl_atualizado
Valor atualizado do título. Ex: 1.500,00
portador
Portador de Cobrança (conta bancária) do título
nosso_numero
Nosso número do título
linha_digitavel
Linha digitável
cod_barra
Código de Barras
link_boleto
URL onde o cliente pode visualizar ou fazer o download do boleto
dt_pagamento
Data de pagamento do título (formato: dd/mm/yyyy)
dt_credito
Data de crédito do título (formato: dd/mm/yyyy)
vl_pago
Valor pago. Ex: 1.500,00
tipo_titulo
Tipo do título. Onde:
Original: Titulo original de uma dívida do devedor com o credor
Negociação: Titulo oriundo de um acordo ou negociação de titulo original
id_negociacao_parcela
Código da negociação em que o titulo é uma parcela (após tipo de
título = 'Negociação')
// Exemplo de JSON devolvido
[
{
"id_devedor":"000000-0000000000000",
"cod_credor":"450",
"cod_devedor":"1111111",
"nome":"Jorge Henrique Lucas",
"tp_pessoa":"F",
"cnpj_cpf":"111111111",
"email":"jorgehenriquelucas@gmail.com.br",
"endereco":"Avenida Paulista",
"numero":"96",
"complemento":"Apto 2",
"bairro":"Bela Vista",
"cidade":"São Paulo",
"estado":"SP",
"cep":"11111111",
"dado_adicional":"Cliente VIP",
"telefones":[
{"fone":"1199999999"},
{"fone":"169999999999"}
],
"id_titulo":"000000-0000000000000",
"cod_titulo":"379116/4",
"parcela":"4",
"status":"A",
"id_titulo_negociacao":"001174-0000000778325",
"dt_vencimento":"13/05/2014",
"dt_programada":"13/05/2014",
"vl_titulo":"324,75",
"vl_saldo":"324,75",
"dt_atualizacao":"30/04/2017",
"vl_atualizado":"324,75",
"portador":"BRADESCO",
"nosso_numero":"000000009277",
"linha_digitavel":"23792.84405 20000.000099 27000.285406 4 44160000032475",
"cod_barra":"23794441600000324752844020000000092700028540",
"link_boleto":"",
"dt_pagto":"01/10/2021",
"dt_credito":"01/10/2021",
"vl_pago":"625,00",
"tipo_titulo":"Original",
"id_negociacao_parcela":"001174-0000000764325"
}
]
Campos devolvidos no response de erro
message
Descrição do erro
// Exemplo de JSON devolvido
[{"message":"Nenhum titulo encontrado"}]
Inserir Título
Insere os dados de um novo título no banco de dados.
POST https://api.sistemadecobranca.com.br:3001/v1/titulo
Accept: application/json
Content-Type: application/json
Body Params
id_devedor
Código do devedor
cod_titulo
Código do título
parcela
Número da parcela
contrato
Número do contrato
dt_geracao
Data de cadastro do título (formato: dd/mm/yyyy)
dt_vencimento
Data de vendimento do título (formato: dd/mm/yyyy)
dt_programada
Data programada do título (formato: dd/mm/yyyy)
vl_titulo
Valor do título. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_saldo
Valor do saldo devedor. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
tp_negocio
Tipo de negpocio
tp_titulo
Tipo do título
comp_1
Dados complementares 1
comp_2
Dados complementares 2
comp_3
Dados complementares 3
portador
Código do portador
nosso_numero
Nosso número do título
linha_digitavel
Linha digitável do título
cod_barra
Código de barras do título
status
Status do título ("A"=Aberto / "P"=Pago / "C"=Cancelado / "S"=Suspenso)
forma_pagto
Forma de pagamento
dt_pagto
Data do pagamento (formato: dd/mm/yyyy)
dt_credito
Data do crédito (formato: dd/mm/yyyy)
vl_pago
Valor pago. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_juros
Valor dos juros. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_desconto
Valor do desconto. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
link_boleto
URL onde o cliente pode visualizar ou fazer o download do boleto
// Exemplo de JSON
{
"id_devedor": "000000-0000000000000",
"cod_titulo": "0000012",
"parcela": "1",
"contrato": "C45152",
"dt_geracao": "18/02/2019 08:57:00",
"dt_vencimento": "18/05/2019",
"dt_programada": "18/05/2019",
"vl_titulo": 150025,
"vl_saldo": 150025,
"tp_negocio": "PADRAO",
"tp_titulo": "FINANCIAMENTO",
"comp_1": "",
"comp_2": "",
"comp_3": "",
"portador": "ITAU",
"nosso_numero": "000000000",
"linha_digitavel": "000000000000000",
"cod_barra": "000000000000000",
"status": "A",
"forma_pagto": "",
"dt_pagto": "",
"dt_credito": "",
"vl_pago": 0,
"vl_juros": 0,
"vl_desconto": 0,
"link_boleto": "https://seusite.com.br/boletos/titulo123.pdf"
}
Campos devolvidos no response
id_titulo
Código identificador do título
// Exemplo de JSON retornado
{
"id_titulo":"008501-0000023852102"
}
Alterar Título
Altera os dados de um título já existente no banco de dados. O identificador de qual título deve ser alterado é enviado na URL da requisição:
PUT https://api.sistemadecobranca.com.br:3001/v1/titulo/{id_titulo}
Accept: application/json
Content-Type: application/json
Body Params
id_devedor
Código do devedor
cod_titulo
Código do título
parcela
Número da parcela
contrato
Número do contrato
dt_geracao
Data de cadastro do título (formato: dd/mm/yyyy)
dt_vencimento
Data de vendimento do título (formato: dd/mm/yyyy)
dt_programada
Data programada do título (formato: dd/mm/yyyy)
vl_titulo
Valor do título. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_saldo
Valor do saldo devedor. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
tp_negocio
Tipo de negpocio
tp_titulo
Tipo do título
comp_1
Dados complementares 1
comp_2
Dados complementares 2
comp_3
Dados complementares 3
portador
Código do portador
nosso_numero
Nosso número do título
linha_digitavel
Linha digitável do título
cod_barra
Código de barras do título
status
Status do título ("A"=Aberto / "P"=Pago / "C"=Cancelado / "S"=Suspenso)
forma_pagto
Forma de pagamento
dt_pagto
Data do pagamento (formato: dd/mm/yyyy)
dt_credito
Data do crédito (formato: dd/mm/yyyy)
vl_pago
Valor pago. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_juros
Valor dos juros. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_desconto
Valor do desconto. Deve ser informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
link_boleto
URL onde o cliente pode visualizar ou fazer o download do boleto
// Exemplo de JSON
{
"id_devedor": "000000-0000000000000",
"cod_titulo": "0000012",
"parcela": "1",
"contrato": "C45152",
"dt_geracao": "18/02/2019 08:57:00",
"dt_vencimento": "18/05/2019",
"dt_programada": "18/05/2019",
"vl_titulo": 150025,
"vl_saldo": 150025,
"tp_negocio": "PADRAO",
"tp_titulo": "FINANCIAMENTO",
"comp_1": "",
"comp_2": "",
"comp_3": "",
"portador": "ITAU",
"nosso_numero": "000000000",
"linha_digitavel": "000000000000000",
"cod_barra": "000000000000000",
"status": "A",
"forma_pagto": "",
"dt_pagto": "",
"dt_credito": "",
"vl_pago": 0,
"vl_juros": 0,
"vl_desconto": 0,
"link_boleto": "https://seusite.com.br/boletos/titulo123.pdf"
}
Campos devolvidos no response
id_titulo
Código identificador do título
// Exemplo de JSON retornado
{
"id_titulo":"008501-0000023852102"
}
Consultar uma Negociação
Utilize esse endpoint para consultar os dados de uma determinada negociação no banco de dados.
Para listar as informações, basta realizar um GET para o endereço abaixo.
Você pode filtrar os dados que serão retornados para você enviando um parâmetro (query param) na URL da requisição.
As opções de filtro estão listadas em "Query Params" logo a seguir.
Campos obrigatórios para consulta: id_negociacao.
GET https://api.sistemadecobranca.com.br:3001/v1/negociacao
Accept: application/json
Content-Type: application/json
Query Params (Filtro dos dados)
id_negociacao
Código identificador da Negociação, retornado pela API na consulta de títulos (Consultar Títulos)
// Exemplo da URL com filtros
https://api.sistemadecobranca.com.br:3001/v1/negociacao?id_negociacao=123
Campos devolvidos no response
Dados da Negociação
negocicao
Número identificador da negociação
historico
Identifica o evento que disparou o POST, como: "Negociacao Criada", "Negociacao Cancelada", etc
credor
Identificador do credor da negociação
cod_devedor
Identificador do devedor
nome_devedor
Nome do devedor
dt_negociacao
Data que a negociação foi realizada
operador
Operador que realizou a negociação
num_parcelas
Quantidade de parcelas da negociação
dt_atualizao_saldo
Data que o saldo da negociação foi atualizado
status
Status da negociação ("A"-Aberto / "C"-Cancelado / "P"-Pago)
dt_negociacao_cancel
Data que a negociação foi cancelada (formato: dd/mm/aaaa)
operador_cancel
Operador responsável pelo cancelamento
obs
Observações da negociação
vl_titulo_original
Valor original dos títulos da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_saldo_original
Valor original do saldo da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_correcao_monetaria
Valor da correção monetária. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_multa
Valor da multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_juros
Valor dos juros. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_desconto
Valor do desconto multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_honorario
Valor dos honerários. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_total_negociado
Valor total da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
indice_correcao_monetaria
Índice de correção monetária usado na negociação
Dados dos Títulos
cod_titulo
Código do título
parcela
Número da parcela
dt_vencimento
Data de vencimento do título (formato: dd/mm/aaaa)
dt_programada
Data programada de pagamento (formato: dd/mm/aaaa)
an_despesa
Descrição da despesa
vl_despesa
Valor da despesa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_titulo_original
Valor original do título. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_saldo_original
Valor do saldo orignal. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_correcao_monetaria
Valor da correção monetária. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_multa
Valor da multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_juros
Valor dos juros. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_desconto
Valor do desconto. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_honorario
Valor do honorário. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_total_negociado
Valor total negociado. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
indice_correcao_monetaria
Índice de correção monetária
Dados das Parcelas
cod_titulo
Código do título
parcela
Número da parcela
vl_parcela
Valor da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_juros_parcelamento
Valor dos juros da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_total_parcela
Valor total da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
Portador
Portador da parcela
forma_pagto
Forma de pagamento
nosso_numero
Nosso número
linha_digitavel
Linha digitável
cod_barra
Código de barras
dt_pagto
Data de pagamento da parcela (formato: dd/mm/aaaa)
dt_credito
Data de crédito da parcela (formato: dd/mm/aaaa)
vl_pagto
Valor pago da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_mora
Valor da mora. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
link_boleto
Link para visualização do boleto no navegador
iugu_id_fatura
Identificado do título na IUGU
iugu_tarifa
Valor da tarifa na IUGU. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
status
Status da parcela da negociação ("A"-Em Aberto / "C"-Cancelada / "N"-Negociada / "P"-Paga)
// Exemplo de JSON devolvido
{
"negociacao": "000010-0000000414413",
"historico": "Negociacao Criada",
"credor": "1",
"cod_devedor": "TESTE001",
"nome_devedor": "Paula Freitas Castro - TESTE",
"dt_negociacao": "30/04/2020",
"operador": "NEGOCIA ONLINE",
"num_parcelas": "1",
"dt_atualizacao_saldo": "30/04/2020",
"status": "A",
"dt_negociacao_cancel": "30/04/2020",
"operador_cancel": "PAULA",'
"obs": "Negocia Facil",
"vl_titulo_original": "5000",
"vl_saldo_original": "5000",
"vl_correcao_monetaria": "0",
"vl_multa": "100",
"vl_juros": "67",
"vl_desconto": "1136",
"vl_honorario": "517",
"vl_total_negociado": "4548",
"indice_correcao_monetaria": "IPCA",
"titulos_negociados": [
{
"cod_titulo": "0000012",
"parcela": "1",
"dt_vencimento": "10/03/2020",
"dt_programada": "10/03/2020",
"an_despesa": "Despesa de teste",
"vl_despesa": "30",
"vl_titulo_original": "3500",
"vl_saldo_original": "3500",
"vl_correcao_monetaria": "0",
"vl_multa": "70",
"vl_juros": "59",
"vl_desconto": "798",
"vl_honorario": "363",
"vl_total_negociado": "3194",
"indice_correcao_monetaria": "IPCA"
},
{
"cod_titulo": "0000012",
"parcela": "2",
"dt_vencimento": "14/04/2020",
"dt_programada": "14/04/2020",
"an_despesa": "Despesa de teste",
"vl_despesa": "30",
"vl_titulo_original": "1500",
"vl_saldo_original": "1500",
"vl_correcao_monetaria": "0",
"vl_multa": "30",
"vl_juros": "8",
"vl_desconto": "338",
"vl_honorario": "154",
"vl_total_negociado": "1354",
"indice_correcao_monetaria": "IPCA"
}
],
"parcelas_negociadas": [
{
"cod_titulo": "NEG-12345",
"parcela": "1",
"vl_parcela": "4548",
"vl_juros_parcelamento": "0",
"vl_total_parcela": "4900",
"portador": "IUGU",
"forma_pagto": "BOLETO",
"nosso_numero": "31108360",
"linha_digitavel": "23793.38128 60003.110834 60000.050801 4 83320000004900",
"cod_barra": "0000000000000000000000000000000000000000000",
"dt_pagto": "14/04/2020",
"dt_credito": "14/04/2020",
"vl_pagto": "4900",
"vl_mora": "0",
"link_boleto": "https://faturas.iugu.com/2779f15c-73f5-4898-b6de-42d39174a501-0000",
"iugu_id_fatura": "2779F15C73F54898B6DE42D39174A501",
"iugu_tarifa": "0",
"status": "A"
}
]
}
Consultar Negociações
Utilize esse endpoint para receber uma lista de negociações do banco de dados.
Para listar as negociações, basta realizar um GET para o endereço abaixo.
Você pode filtrar os dados que serão retornados para você enviando os parâmetros na URL da requisição (Query Params).
As opções de filtro estão listadas em "Query Params" logo a seguir.
GET https://api.sistemadecobranca.com.br:3001/v1/negociacoes
Accept: application/json
Content-Type: application/json
Query Params (Filtro dos dados)
status
Status da negociação ("A"=Aberta / "P"=Paga / "C"=Cancelada)
cod_credor
Código do Credor
dt_negociacao_de
Data inicial da negociação (formato: dd/mm/yyyy)
dt_negociacao_ate
Data final da negociação (formato: dd/mm/yyyy)
dt_cancelamento_de
Data inicial de cancelamento da negociação (formato: dd/mm/yyyy)
dt_cancelamento_ate
Data final de cancelamento da negociação (formato: dd/mm/yyyy)
num_pagina
Número da página a ser retornada
// Exemplo da URL com filtros
https://api.sistemadecobranca.com.br:3001/v1/negociacoes?status=A&cod_credor=010
Campos devolvidos no response
Dados da Negociação
negocicao
Número identificador da negociação
historico
Identifica o evento que disparou o POST, como: "Negociacao Criada", "Negociacao Cancelada", etc
credor
Identificador do credor da negociação
cod_devedor
Identificador do devedor
nome_devedor
Nome do devedor
dt_negociacao
Data que a negociação foi realizada
operador
Operador que realizou a negociação
num_parcelas
Quantidade de parcelas da negociação
dt_atualizao_saldo
Data que o saldo da negociação foi atualizado
status
Status da negociação ("A"-Aberto / "C"-Cancelado / "P"-Pago)
dt_negociacao_cancel
Data que a negociação foi cancelada (formato: dd/mm/aaaa)
operador_cancel
Operador responsável pelo cancelamento
obs
Observações da negociação
vl_titulo_original
Valor original dos títulos da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_saldo_original
Valor original do saldo da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_correcao_monetaria
Valor da correção monetária. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_multa
Valor da multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_juros
Valor dos juros. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_desconto
Valor do desconto multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_honorario
Valor dos honerários. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_total_negociado
Valor total da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
indice_correcao_monetaria
Índice de correção monetária usado na negociação
Dados dos Títulos
cod_titulo
Código do título
parcela
Número da parcela
dt_vencimento
Data de vencimento do título (formato: dd/mm/aaaa)
dt_programada
Data programada de pagamento (formato: dd/mm/aaaa)
an_despesa
Descrição da despesa
vl_despesa
Valor da despesa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_titulo_original
Valor original do título. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_saldo_original
Valor do saldo orignal. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_correcao_monetaria
Valor da correção monetária. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_multa
Valor da multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_juros
Valor dos juros. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_desconto
Valor do desconto. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_honorario
Valor do honorário. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_total_negociado
Valor total negociado. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
indice_correcao_monetaria
Índice de correção monetária
Dados das Parcelas
cod_titulo
Código do título
parcela
Número da parcela
vl_parcela
Valor da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_juros_parcelamento
Valor dos juros da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_total_parcela
Valor total da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
Portador
Portador da parcela
forma_pagto
Forma de pagamento
nosso_numero
Nosso número
linha_digitavel
Linha digitável
cod_barra
Código de barras
dt_pagto
Data de pagamento da parcela (formato: dd/mm/aaaa)
dt_credito
Data de crédito da parcela (formato: dd/mm/aaaa)
vl_pagto
Valor pago da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
vl_mora
Valor da mora. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000.
link_boleto
Link para visualização do boleto no navegador
iugu_id_fatura
Identificado do título na IUGU
iugu_tarifa
Valor da tarifa na IUGU. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
status
Status da parcela da negociação ("A"-Em Aberto / "C"-Cancelada / "N"-Negociada / "P"-Paga)
// Exemplo de JSON devolvido
{
"negociacao": "000010-0000000414413",
"historico": "Negociacao Criada",
"credor": "1",
"cod_devedor": "TESTE001",
"nome_devedor": "Paula Freitas Castro - TESTE",
"dt_negociacao": "30/04/2020",
"operador": "NEGOCIA ONLINE",
"num_parcelas": "1",
"dt_atualizacao_saldo": "30/04/2020",
"status": "A",
"dt_negociacao_cancel": "30/04/2020",
"operador_cancel": "PAULA",'
"obs": "Negocia Facil",
"vl_titulo_original": "5000",
"vl_saldo_original": "5000",
"vl_correcao_monetaria": "0",
"vl_multa": "100",
"vl_juros": "67",
"vl_desconto": "1136",
"vl_honorario": "517",
"vl_total_negociado": "4548",
"indice_correcao_monetaria": "IPCA",
"titulos_negociados": [
{
"cod_titulo": "0000012",
"parcela": "1",
"dt_vencimento": "10/03/2020",
"dt_programada": "10/03/2020",
"an_despesa": "Despesa de teste",
"vl_despesa": "30",
"vl_titulo_original": "3500",
"vl_saldo_original": "3500",
"vl_correcao_monetaria": "0",
"vl_multa": "70",
"vl_juros": "59",
"vl_desconto": "798",
"vl_honorario": "363",
"vl_total_negociado": "3194",
"indice_correcao_monetaria": "IPCA"
},
{
"cod_titulo": "0000012",
"parcela": "2",
"dt_vencimento": "14/04/2020",
"dt_programada": "14/04/2020",
"an_despesa": "Despesa de teste",
"vl_despesa": "30",
"vl_titulo_original": "1500",
"vl_saldo_original": "1500",
"vl_correcao_monetaria": "0",
"vl_multa": "30",
"vl_juros": "8",
"vl_desconto": "338",
"vl_honorario": "154",
"vl_total_negociado": "1354",
"indice_correcao_monetaria": "IPCA"
}
],
"parcelas_negociadas": [
{
"cod_titulo": "NEG-12345",
"parcela": "1",
"vl_parcela": "4548",
"vl_juros_parcelamento": "0",
"vl_total_parcela": "4900",
"portador": "IUGU",
"forma_pagto": "BOLETO",
"nosso_numero": "31108360",
"linha_digitavel": "23793.38128 60003.110834 60000.050801 4 83320000004900",
"cod_barra": "0000000000000000000000000000000000000000000",
"dt_pagto": "14/04/2020",
"dt_credito": "14/04/2020",
"vl_pagto": "4900",
"vl_mora": "0",
"link_boleto": "https://faturas.iugu.com/2779f15c-73f5-4898-b6de-42d39174a501-0000",
"iugu_id_fatura": "2779F15C73F54898B6DE42D39174A501",
"iugu_tarifa": "0",
"status": "A"
}
]
}
Consultar Contatos
Utilize esse endpoint para consultar os contatos realizados com os devedores de forma ativa ou receptiva.
Para listar os contatos, basta realizar um GET para o endereço abaixo.
Você pode filtrar os dados que serão retornados para você enviando parâmetros na própria URL da requisição.
As opções de filtro estão listadas em "Query Params" logo a seguir.
Campos obrigatórios para consulta: num_pagina, dt_contato_ini e dt_contato_fim.
GET https://api.sistemadecobranca.com.br:3001/v1/contato
Accept: application/json
Content-Type: application/json
Query Params (Filtro dos dados)
num_pagina
Número da página de dados a ser retornada
dt_contato_ini
Data de contato inicial (formato: dd/mm/yyyy)
dt_contato_fim
Data de contato final (formato: dd/mm/yyyy)
cod_credor
Código do Credor
cod_devedor
Código do Devedor
// Exemplo da URL com filtros
https://api.sistemadecobranca.com.br:3001/v1/contato?num_pagina=1&dt_contato_ini=01/01/2023&dt_contato_fim=15/01/2023
Campos devolvidos no response
id_contato
Número identificador do contato
credor_cod
Identificador do credor
credor_nome
Nome do credor
cod_devedor
Identificador do devedor
nome_devedor
Nome do devedor
dt_contato_inicio
Data de início do contato
dt_contato_fim
Data de término do contato
duracao_contato
Quanto tempo durou o contato com o devedor
operador_cod
Operador que realizou o contato
operador_nome
Nome do operador que realizou o contato
grupo_motivo
Grupo do motivo
motivo
Descrição do motivo
grupo_resultado_contato
Grupo da tabulação do contato
resultado_contato
Tabulação do contato
texto_contato
O que foi combinado no contato
operador_agendamento
Operador que está agendado para fazer o próximo contato
dt_agendamento
Quando será feito o próximo contato
tipo_contato
O contato pode ser ativo ou receptivo
// Exemplo de JSON devolvido
{
"contatos": [
{
"id_contato": 11502801,
"credor_cod": "ABC",
"credor_nome": "ABC Informatica",
"cod_devedor": "00.000.000/0001-00",
"nome_devedor": "João da Silva",
"cnpj_cpf": "00000000000",
"dt_contato_inicio": "04/01/2023 13:54",
"dt_contato_fim": "04/01/2023 13:55",
"duracao_contato": "00:01",
"operador_cod": "Paula F. Castro",
"operador_nome": "Paula F. Castro",
"grupo_motivo": "FINANCEIRO",
"motivo": "Desconhecido",
"grupo_resultado_contato": "TENTATIVA DE CONTATO",
"resultado_contato": "Ocupado",
"texto_contato": "Telefone ocupado",
"operador_agendamento": "",
"dt_agendamento": "05/01/2023 08:00",
"tipo_contato": "Ativo"
}]
}
Introdução ao Webhook
Webhooks permitem que sistemas externos recebam notificações de todos os eventos que ocorrem na API Cedrus.
Quando uma negociação é realizada ou sofre qualquer alteração dentro do Cedrus, a API envia uma requisição HTTP (POST) para a URL configurada no webhook com as informações relativas a negociação.
Ao receber a notificação, o sistema integrado a API pode executar diversas tarefas, dependendo do seu objetivo.
Eventos de Notificação
Seu sistema será notificado sempre que houver um dos seguintes eventos dentro do Cedrus:
- Negociação Realizada: sempre que uma nova negociação é feita;
- Cancelamento: sempre que uma negociação for cancelada;
- Alteração dos Dados: sempre que uma alteração manual for feita na negociação ou nas parcelas;
- Pagamento: sempre que uma parcela de negociação é marcada como paga;
Dados Retornados
A cada POST enviado da nossa API para seu sistema, as seguintes informações são enviados no corpo (body) da requisição no formato JSON para sua URL configurada:
Dados da Negociação
negocicao
Número identificador da negociação
historico
Identifica o evento que disparou o POST, como: "Negociacao Criada", "Negociacao Cancelada", etc
credor
Identificador do credor da negociação
cod_devedor
Identificador do devedor
nome_devedor
Nome do devedor
dt_negociacao
Data que a negociação foi realizada
operador
Operador que realizou a negociação
num_parcelas
Quantidade de parcelas da negociação
dt_atualizao_saldo
Data que o saldo da negociação foi atualizado
status
Status da negociação ("A"-Aberto / "C"-Cancelado / "P"-Pago)
dt_negociacao_cancel
Data que a negociação foi cancelada (formato: dd/mm/aaaa)
operador_cancel
Operador responsável pelo cancelamento
obs
Observações da negociação
vl_titulo_original
Valor original dos títulos da negociação
vl_saldo_original
Valor original do saldo da negociação
vl_correcao_monetaria
Valor da correção monetária
vl_multa
Valor da multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_juros
Valor dos juros. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_desconto
Valor do desconto multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_honorario
Valor dos honerários. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_total_negociado
Valor total da negociação. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
indice_correcao_monetaria
Índice de correção monetária usado na negociação
Dados dos Títulos
id_titulo
Código identificador do título, retornado pela API na criação do título (Inserir Título)
cod_titulo
Código do título
parcela
Número da parcela
dt_vencimento
Data de vencimento do título (formato: dd/mm/aaaa)
dt_programada
Data programada de pagamento (formato: dd/mm/aaaa)
an_despesa
Descrição da despesa
vl_despesa
Valor da despesa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_titulo_original
Valor original do título. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_saldo_original
Valor do saldo orignal. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_correcao_monetaria
Valor da correção monetária. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_multa
Valor da multa. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_juros
Valor dos juros. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_desconto
Valor do desconto. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_honorario
Valor do honorário. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_total_negociado
Valor total negociado. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
indice_correcao_monetaria
Índice de correção monetária
Dados das Parcelas
id_titulo
Código identificador do título, retornado pela API na criação do título (Inserir Título)
cod_titulo
Código do título
parcela
Número da parcela
vl_parcela
Valor da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_juros_parcelamento
Valor dos juros da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_total_parcela
Valor total da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
Portador
Portador da parcela
forma_pagto
Forma de pagamento
nosso_numero
Nosso número
linha_digitavel
Linha digitável
cod_barra
Código de barras
dt_pagto
Data de pagamento da parcela (formato: dd/mm/aaaa)
dt_credito
Data de crédito da parcela (formato: dd/mm/aaaa)
vl_pagto
Valor pago da parcela. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
vl_mora
Valor da mora. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
link_boleto
Link para visualização do boleto no navegador
iugu_id_fatura
Identificado do título na IUGU
iugu_tarifa
Valor da tarifa na IUGU. É informado no formato inteiro (sem ponto ou vírgula). Ex: o valor 1.500,00 deve ser informado como 150000
status
Status da parcela da negociação ("A"-Em Aberto / "C"-Cancelada / "N"-Negociada / "P"-Paga)
// Exemplo de JSON enviado pelo Webhook
{
"negociacao": "000010-0000000414413",
"historico": "Negociacao Criada",
"credor": "1",
"cod_devedor": "TESTE001",
"nome_devedor": "Paula Freitas Castro - TESTE",
"dt_negociacao": "30/04/2020",
"operador": "NEGOCIA ONLINE",
"num_parcelas": "1",
"dt_atualizacao_saldo": "30/04/2020",
"status": "A",
"dt_negociacao_cancel": "30/04/2020",
"operador_cancel": "PAULA",'
"obs": "Negocia Facil",
"vl_titulo_original": "5000",
"vl_saldo_original": "5000",
"vl_correcao_monetaria": "0",
"vl_multa": "100",
"vl_juros": "67",
"vl_desconto": "1136",
"vl_honorario": "517",
"vl_total_negociado": "4548",
"indice_correcao_monetaria": "IPCA",
"titulos_negociados": [
{
"id_titulo":"000000-0000000000000"
"cod_titulo": "379116/1",
"parcela": "1",
"dt_vencimento": "10/03/2020",
"dt_programada": "10/03/2020",
"an_despesa": "Despesa de teste",
"vl_despesa": "30",
"vl_titulo_original": "3500",
"vl_saldo_original": "3500",
"vl_correcao_monetaria": "0",
"vl_multa": "70",
"vl_juros": "59",
"vl_desconto": "798",
"vl_honorario": "363",
"vl_total_negociado": "3194",
"indice_correcao_monetaria": "IPCA"
},
{
"id_titulo":"000000-0000000000000"
"cod_titulo": "379116/1",
"parcela": "2",
"dt_vencimento": "14/04/2020",
"dt_programada": "14/04/2020",
"an_despesa": "Despesa de teste",
"vl_despesa": "30",
"vl_titulo_original": "1500",
"vl_saldo_original": "1500",
"vl_correcao_monetaria": "0",
"vl_multa": "30",
"vl_juros": "8",
"vl_desconto": "338",
"vl_honorario": "154",
"vl_total_negociado": "1354",
"indice_correcao_monetaria": "IPCA"
}
],
"parcelas_negociadas": [
{
"cod_titulo": "NEG-12345",
"parcela": "1",
"vl_parcela": "4548",
"vl_juros_parcelamento": "0",
"vl_total_parcela": "4900",
"portador": "IUGU",
"forma_pagto": "BOLETO",
"nosso_numero": "31108360",
"linha_digitavel": "23793.38128 60003.110834 60000.050801 4 83320000004900",
"cod_barra": "0000000000000000000000000000000000000000000",
"dt_pagto": "14/04/2020",
"dt_credito": "14/04/2020",
"vl_pagto": "4900",
"vl_mora": "0",
"link_boleto": "https://faturas.iugu.com/2779f15c-73f5-4898-b6de-42d39174a501-0000",
"iugu_id_fatura": "2779F15C73F54898B6DE42D39174A501",
"iugu_tarifa": "0",
"status": "A"
}
]
}
Configurações do Webhook
Para configurar o webhook na sua conta Cedrus, acesse o menu com o nome da sua empresa e depois escolha a opção "Integração API":
A seguinte tela é aberta e você pode configurar a URL para o webhook fazer as requisições:
Introdução Discador
A API Discador tem como objetivo integrar o sistema de cobrança Cedrus os discadores automáticos do mercado.
Dependendo da estrutura do seu software discador, é necessário desenvolver algumas rotinas específicas nele para poder consumir nossas APIs. Para saber isso,
entre em contato o fornecedor do seu discador e verifique essa possibilidade de integração com o Cedrus.
A integração começa com o envio ou carga dos dados dos devedores para dentro do discador. Através da API de carga do mailing, o discador faz uma
requisição (através de um POST para nosso endpoint) solicitando mais contatos para ele fazer as ligações.
Como resultado dessa requisição, o Cedrus devolve para o discador uma lista de contatos a serem trabalhados.
Conforme o discador vai processando os contatos e tentando realizar as ligações, ele deve notificar a API Discador (através de um POST para nosso endpoint)
indicando se o contato foi realizado com sucesso ou não. Para essa operação, damos o nome de atualização de contato.
A URL base para fazer as chamadas é: https://api.sistemadecobranca.com.br:3001/v1/
Autenticação
A autenticação nas chamadas dos serviços é feita através da utilização de uma APIKEY (diferente da APIKey utilizada para cadastro de devedores/títulos). Existe uma
APIKey exclusiva para uso na integração com os discadores.
Para obter essa key, entre em contato com o suporte pelo email
suporte@rdz.com.br e solicite a APIKEY Discador da sua empresa.
A maneira de se autenticar é utilizando basic access authentication. Envie sua API Key como username da autenticação básica
sem necessidade de nenhuma password (senha).
Carga do Mailing
Monta uma lista com todos os contatos das campanhas a serem trabalhadas pelo discador. Os contatos que estiverem no discador e não estiverem mais nos
mailings devolvidos pela API devem ser retirados da fila no discador.
POST https://api.sistemadecobranca.com.br:3001/v1/mailing
Accept: application/json
Content-Type: application/json
Para efeito de filtro nos dados do mailing, esse endpoint aceita o parâmetro abaixo caso seja necessário receber apenas os
contatos de uma determinada campanha. Se o "cod_campanha" não for enviado no corpo da requisição, todos os contatos de todas
as campanhas de discador serão listadas no resultado.
Body Params
cod_campanha
Informe o código da campanha caso deseje receber apenas os contatos dessa campanha específica (campo não obrigatório)
Campos devolvidos no response
mailind_id
Identificador único do mailing
cod_campanha
Identificador da campanha de discagem
cod_devedor
Código do devedor
nome
Nome do devedor
cnpj_cpf
CNPJ ou CPF do devedor
telefones
Lista dos telefones a serem discados (com DDD).
operador
Código do operador (caso o contato deva ser encaminhado para um agente específico)
dt_fup
Data e hora agendada para realização do contato telefônico (formato: dd/mm/aaaa hh:mm)
// Exemplo de JSON devolvido
[{"mailing_id":"357",
"cod_campanha":"PADRAO",
"contatos": [
{
"cod_devedor":"458412",
"nome": "JOSE DA SILVA",
"cnpj_cpf": "29943894877",
"telefones":[{"telefone":"11999999999"}, {"telefone":"11888888888"}],
"operador":"EDUARDO",
"dt_fup":"18/09/2020 08:00"
},
{
"cod_devedor":"485401",
"nome": "DANIEL SANTOS - ME",
"cnpj_cpf": "14053954000100",
"telefones":[{"telefone":"11777777777"}, {"telefone":"11666666666"}],
"operador":"JOSE",
"dt_fup":"19/09/2020 10:00"
} ]
},
{"mailing_id":"357",
"cod_campanha":"TESTE",
"contatos": [
{
"cod_devedor":"485412",
"nome": "IMPRIMAX LTDA",
"cnpj_cpf": "12053954000100",
"telefones":[{"telefone":"11999999999"}, {"telefone":"11888888888"}],
"operador":"ANA",
"dt_fup":"18/09/2020 08:00"
},
{
"cod_devedor":"485401",
"nome": "DANIELLE ASSIS",
"cnpj_cpf": "29948752544",
"telefones":[{"telefone":"11777777777"}, {"telefone":"11666666666"}],
"operador":"MARIA",
"dt_fup":"19/09/2020 10:00"
} ]
}]
Atualização dos Contatos
Atualiza as informações dentro do Cedrus com as tentivas ou contatos realizados pelo discador.
POST https://api.sistemadecobranca.com.br:3001/v1/contato
Accept: application/json
Content-Type: application/json
Body Params
cod_campanha
Identificador da campanha de discagem
cod_devedor
Código do devedor
status
Status do contato. Onde:
0 - Atendida: Atendida e transferida para o agente
1 - Ocupado: Telefone ocupado
2 - Fax: Atendida por fax
3 - Não atende: Não atende
4 - Não completada: Chamada não completada pela rede
5 - Atend. eletrônico: Atendimento eletrônico
7 - Inválido: Número inválido
8 - Cancelada: Chamada cancelada, indisponibilidade
9 - Terminada: Chamada terminada antes da monitoração
10 - Indisponível: Atendida, agentes indisponíveis
11 - Deslogado: Agente não disponível para fidelizado
12 - Fidelizada: Agente em chamada fidelizada
13 - Receptiva: Chamada receptiva
14 - Abandonada: Chamada receptiva abandonada
-1 - Sem telefone: Contato com nenhum telefone cadastrado
-2 - Sem telefone: Contato sem telefone na estratégia
15 - Manual: Chamada manual
16 - Manual atend: Chamada manual atendida
17 - Preview: No agente para chamada preview
tentativas
Número de tentativas de contato
telefone
Telefone pelo qual foi feito o contato
operador
Operador que realizou o contato
data_contato
Data da realização do contato (formato: dd/mm/aaaa hh:mm)
duracao
Duracação da chamada (formato: hh:mm:ss)
link_gravacao
URL para consultar a gravação da chamada realizada
// Exemplo de JSON
{
"cod_campanha":"357",
"cod_devedor": "485412"
"status": "1",
"tentativas":"2",
"telefone":"11999999999",
"operador":"EDUARDO",
"data_contato":"18/09/2020 08:15",
"duracao": "00:08:34",
"link_gravacao": "https://meudiscador.com.br/call00001.mp3"
}
Quando o discador consegue contato com um determinado devedor, ele envia uma requisição para o endpoint abaixo para que o
Cedrus abra uma tela com todos os detalhes do devedor que está na linha.
POST https://api.sistemadecobranca.com.br:3001/v1/popup
Accept: application/json
Content-Type: application/json
Body Params
cod_devedor
Código do devedor
telefone
Telefone pelo qual foi feito o contato
operador
Operador que realizou o contato
// Exemplo de JSON
{
"cod_devedor": "458412",
"telefone":"11999999999",
"operador": "EDUARDO"
}
Controle do Operador
Utilizado para controlar a disponibilidade do operador em receber contatos do discador.
Através de uma URL configurada dentro do Cedrus, sempre que um operador fica disponível / indisponível para receber contatos do discador,
a nossa API envia um POST para a URL configurada indicando se esse operador deve continuar ou sair da fila de chamadas do discador.
Content-Type: application/json
Body Params
operador
Código do operador
disponivel
Indica a disponibilidade do operador (Valores possíveis: true / false)
cod_motivo
Caso o operador não esteja disponível, será enviado o código do motivo (enviado somente nos casos de desconexão)
motivo
Caso o operador não esteja disponível, será enviado a descrição do motivo (enviado somente nos casos de desconexão)
ramal
Número do ramal do operador
campanhas
Lista das campanhas que o operador trabalha
Para configurar a URL que o Cedrus deve enviar o POST, acesse o menu com o nome da sua empresa e depois escolha a opção "Integração Discador":
A seguinte tela é aberta e você pode configurar a URL para o Cedrus enviar as requisições:
// Exemplo de JSON enviado ao CONECTAR
{
"operador": "HEBER",
"disponivel": true,
"ramal": "105"
"campanhas": ["CAMPANHA 1", "CAMPANHA 2"]
}
// Exemplo de JSON enviado ao DESCONECTAR
{
"operador": "HEBER",
"disponivel": false,
"cod_motivo": "001"
"motivo": "Pausa para almoço",
"ramal": "105",
"campanhas": ["CAMPANHA 1", "CAMPANHA 2"]
}