Rotas do Cedente

---

Alterando um Cedente

A Alteração de um Cedente se resume em preenchermos um modelo de integração (JSON) com os dados do Cedente a serem alterados e enviarmos para o nosso servidor. Dessa forma, todos os dados solicitados para alteração, serão alterados instantaneamente em nossa base de dados.

 

---

PUT

 Homologação:

 Produção:

*Deve ser informado o id do cedente na URL da requisição. É o mesmo ID retornado na rotina de cadastro do cedente
 

 

---

Headers

 

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-sh	CNPJ ou CPF da Software House	01001001000113
token-sh	Token da Software House	f22b97c0c9a3d41ac0a3875aba69e5aa
cnpj-cedente	CNPJ ou CPF do cedente	01001001000113

 

 

---

Body

 

Campo	Tipo	Descrição
CedenteRazaoSocial	string	Razão Social do Cedente
CedenteNomeFantasia	string	Nome Fantasia do Cedente
CedenteEnderecoLogradouro	string	Endereço do Cedente
CedenteEnderecoNumero	string	Número do logradouro do endereço
CedenteEnderecoComplemento	string	Complemento do endereço
CedenteEnderecoBairro	string	Nome do bairro
CedenteEnderecoCEP	string	CEP do Cedente
CedenteEnderecoCidadeIBGE	string	Código IBGE da cidade do Cedente
CedenteTelefone	string	Número do telefone do Cedente
CedenteEmail	string	E-mail do Cedente

 

Exemplo:

---

Retorno

 

Exemplo de retorno:

 

 

Exemplo de retorno com erro:

 

---

Gerando relatório de cedentes

Relatórios sobre o volume de emissão

A opção de relatórios é disponível apenas para o ambiente de PRODUÇÃO.

 

---

POST

Produção:

https://plugboleto.com.br/api/v1/relatorio

 

---

Headers

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-sh	CNPJ da Software House	12123123123412
token-sh	Token da Software House	f22b91c0c9a3d22ac0a3875aba69e5aa

 

---

Campos do Json

Para geração do relatório, os campos exibidos abaixo devem ser adicionados no json:

Campos obrigatórios serão destacados com asterisco.

Campo	Tipo	Descrição
cedentes*	array	Lista contendo os CNPJs dos cedentes para os quais o relatório deve ser gerado. Os CNPJs devem ser informados sem pontuação. Exemplo: ["12123123123412", "98765432100012"].
situacoes*	array	Lista das situações dos boletos que deseja incluir no relatório. Os valores possíveis são: "EMITIDO", "FALHA", "REJEITADO", "REGISTRADO", "LIQUIDADO" e "BAIXADO".
dataInicial*	string	Data inicial para a geração do relatório no formato DD/MM/AAAA.
dataFinal*	string	Data final para a geração do relatório no formato DD/MM/AAAA.
nomeRelatorio	string	Nome desejado para o relatório.
tipoRelatorio*	string	Tipo de relatório desejado. Os valores possíveis são: "RESUMIDO" ou "COMPLETO".   RESUMIDO CNPJ do cedente, Código do banco, Número da conta, Agencia, Quantidade. COMPLETO idintegracao, cedente_cpf_cnpj, Código do banco, Número da conta, Agencia, criado, situacao, SacadoCPFCNPJ, razaosocial, SacadoNome, TituloValor, PagamentoValorPago, PagamentoData, PagamentoValorTaxaCobranca, TituloNumeroDocumento, TituloDataVencimento.

 

---

Body

Exemplo de JSON:

{
"cedentes": [
"12123123123412"
],
"situacoes": [
"EMITIDO",
"FALHA",
"REJEITADO",
"REGISTRADO",
"LIQUIDADO",
"BAIXADO"
],
"dataInicial": "01/04/2024",
"dataFinal": "30/04/2024",
"nomeRelatorio": "Abril 2024",
"tipoRelatorio": "RESUMIDO"
}

 

---

Retorno

Exemplo de JSON retorno:

{
"_status": "sucesso",
"_mensagem": "Solicitação pendente de processamento",
"_dados": {
"situacao": "PROCESSANDO",
"protocolo": "C17UB74KM"
}
}

 

Exemplo de retorno com erro:

{
"_status": "erro",
"_mensagem": "Erro inesperado. Tente novamente mais tarde.",
"_dados": [
{
"_erro": "[Error (E_UNKNOWN) Encountered an unexpected error] Details: { erroValidacao: true,\n erros: { cedentes: 'Campo obrigatório.' } }\n"
}
]
}

 

Em caso de sucesso, a rota irá retornar um número de protocolo através do campo "protocolo", o qual poderá ser consultado através da GUI do cedente na aba de Emissão de Relatórios para download do arquivo ou envio via e-mail.

---

Consultando um cedente

Para consultar cedentes, basta utilizar a mesma rota utilizada no cadastro (POST), alterando para GET e informando uma QueryString para aplicar um filtro, abaixo temos exemplos de como realizar tais consultas:

Como base devem ser utilizada as seguintes URl's

 Homologação:

 Produção:

 

Para consultar um cedente por cnpj utilizando com exemplo a url de homologação devemos utilizar a seguinte url:

 

No resultado desta busca será retornado, apenas o cedente que possui o CNPJ 01001001000113.

 

---

 

Inativando um cedente

Para inativar cedentes, basta utilizar a mesma rota utilizada no cadastro POST, alterando para PUT e informando o ID do cedente a ser inativado na frente do endpoint para aplicar um filtro, abaixo temos exemplos de como realizar tais consultas:

Como base devem ser utilizada as seguintes URl's

 Homologação:

 Produção:

 

Além disso, deve ser enviado os campos abaixo no formato de JSON:

 

Campo	Tipo	Descrição
ativo*	boolean	Mandar como true para ativar o cedente ou false para inativa-lo
motivoInativacao*	string	Apenas requisitado se o campo ativo for enviado como false, onde deve ser informado o motivo de inativação do cedente.

 

Body

Exemplo de JSON:

{

 "ativo": false,

 "motivoInativacao": "Cliente inadimplente"

}

Exemplo de JSON retorno:

{

 "_status": "sucesso",

 "_dados": "Cedente: TESTE foi inativado"

}