Essa rota é utilizada para identificar o total de boletos emitidos em um determinado período, e também um totalizador de boletos emitidos via van.
GET
Homologação:
https://homologacao.plugboleto.com.br/api/v1/software-house/relatorios/bilhetagem
Produção:
Headers
| Nome | Descrição | Exemplo |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
FILTRO
Para realizar a consulta de vários CNPJs informe o campo cnpjcedente adicionando virgula para separar os cnpjs.
exemplo de consulta:
http://homologacao.plugboleto.com.br/api/v1/software-house/relatorios/bilhetagem?datainicial=01/05/2021&datafinal=01/06/2021&cnpjcedente=12628502000140,01001001000113
Os filtros disponíveis são:
| Campos disponíveis para filtro na querystring: |
| cnpjcedente (opcional) |
| datainicial (obrigatório) |
| datafinal (obrigatório) |
| idContas ( Opcional ) |
OBS:
Nos campos de data é necessário informar no padrão DD/MM/YYYY.
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"total": 2,
"cedentes": [
{
"cnpj": "01001001000113",
"situacao": "ATIVO",
"totalVan": 0,
"totalSemVan": 2,
"total": 2
},
{
"cnpj": "12628502000140",
"situacao": "ATIVO",
"totalVan": 0,
"totalSemVan": 0,
"total": 0
}
]
}
}
Exemplo de retorno com contas:
{
"_status": "sucesso",
"_dados": {
"total": 32,
"cedentes": [
{
"cnpj": "01001001000113",
"situacao": "ATIVO",
"totalVan": 0,
"totalSemVan": 32,
"total": 32
}
],
"cedentesContas": [
{
"cnpj": "01001001000113",
"situacao": "ATIVO",
"total": 6,
"contas": [
{
"id": 1,
"codBanco": "748",
"conta": "12345",
"contaDv": "6",
"agencia": "1234",
"agenciaDv": null,
"totalVan": 0,
"totalSemVan": 4,
"total": 4
},
{
"id": 2,
"codBanco": "237",
"conta": "56789",
"contaDv": "8",
"agencia": "1234",
"agenciaDv": "2",
"totalVan": 0,
"totalSemVan": 2,
"total": 2
}
]
}
]
}
}
Exemplo de erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "dataFinal",
"_erro": "Campo obrigatório."
}
]
}
Volumetria apurada pela Tecnospeed
A apuração da volumetria para cálculo de consumo é feita pela Tecnospeed considerando os seguintes status na base de dados de boletos:
Status que são considerados na apuração do consumo:
REGISTRADO
EMITIDO
LIQUIDADO
BAIXADO
Status que são desconsiderados na apuração do consumo:
SALVO
REJEITADO
FALHA
DESCARTADO
Comentários
0 comentário
Por favor, entre para comentar.