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". |
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.
Comentários
0 comentário
Por favor, entre para comentar.