Nesta rota, você pode consultar todo o histórico de relatórios gerados .
GET
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 |
Query Parameters
| Nome | Descrição | Exemplo |
|
limit |
Indica o limite de relatórios por página. Se não for especificado, o padrão será de 20 itens por página. | 40 |
|
skip |
Indica a quantidade de itens a serem pulados, ou seja, aqueles que não serão exibidos na página. | 20 |
|
protocolo |
Código do protocolo de um relatório específico. | 718HZJFAP |
Retorno
Exemplo de JSON retorno:
{
"_status": "sucesso",
"_dados": [
{
"id": 123,
"id_software_house": 1,
"cedentes": [
"12123123123412"
],
"situacoes": [
"EMITIDO",
"REGISTRADO",
"LIQUIDADO",
"BAIXADO"
],
"nome_relatorio": "Relatorio",
"data_inicial": "01/01/2024",
"data_final": "31/01/2024",
"protocolo": "Cv2P9M08b",
"situacao": "PROCESSADO",
"tipo_relatorio": "COMPLETO"
}
],
"_meta": {
"_itens_por_pagina": 1,
"_paginacao": {
"_proximo": "https://plugboleto.com.br/api/v1/relatorio?limit=1&id_software_house=12&skip=1",
"_anterior": false
},
"_total": 103
}
}
Comentários
0 comentário
Por favor, entre para comentar.