Essa rota tem o objetivo de retornar uma lista com os dados dos arquivos de retornos, que foram retornados via VAN.
GET
Produção:
https://plugboleto.com.br/api/v1/boletos/retornos
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 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Params
| Campo | Tipo | Descrição |
| dataInicial | string | Data inicial formato dd/mm/yyyy |
| dataFinal | string | Data final formato dd/mm/yyyy |
| limit | number | Limite de arquivos retornados na página. |
| page | number | Paginá atual. |
| conciliado | string |
Indica se a consulta retornará apenas boletos conciliados, não conciliados ou ambos. Valores aceitos: sim, nao e ambos
- sim: A consulta retornará apenas os boletos que foram conciliados. - nao: Serão retornados apenas os boletos que ainda não foram conciliados. - ambos:A consulta apresentará tanto os boletos conciliados quanto os não conciliados. |
| retornosType | string |
Determina se a consulta retornará boletos conciliados ou não conciliados de forma manual, via van ou todos os tipos.
- manual: A consulta retornará apenas boletos que foram conciliados ou não conciliados manualmente. - van: Serão retornados apenas os boletos que foram conciliados ou não conciliados pela transmissão automática. - todos: A consulta apresentará os boletos conciliados ou não conciliados das transmissões manual e van.
Se não for especificado, o padrão será todos. |
Retorno
O retorno será enviado o id do retorno, juntamento com um array com os idintegracao dos boletos que o retorno possui.
No grupo de informações _meta, será retornado algumas informações para realização de paginação, detalhes:
| Campo | Tipo | Descrição |
| page | string | Paginá atual. |
| totalPages | number | Total de páginas. |
| totalRecords | string | Quantidade total de registros. |
Exemplo de retorno:
Exemplo de retorno com erro:
Comentários
0 comentário
Por favor, entre para comentar.