Com a consulta de remessas por período, é possível consultar as remessas geradas em determinado período para o cedente consultado, onde será encaminhado um link para download da remessa, juntamente com outros detalhes da remessa.
GET
Homologação:
https://homologacao.plugboleto.com.br/api/v1/remessas/lote
Produção:
https://plugboleto.com.br/api/v1/remessas/lote
Headers
| Nome | Descrição | Exemplo |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpj-cedente | CNPJ 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 |
FILTRO
Para fazer uma consulta utilizando filtros adicione nos parâmetros de URL os campos disponíveis para consulta, os campos disponíveis estão a baixo na tabela QueryString.
QueryString:
| Nome | Descrição | Exemplo |
| dataInicial | Data inicial | 10/09/20220 |
| dataFinal | Data final | 10/10/20220 |
| limit | limite de registros retornados no json | 1 |
| page | página | 1 |
PAGINAÇÃO
Utilize os parâmetros limit (para limitar a quantidade) e page (para selecionar a página consultada).
No retorno da consulta será retornado um campo chamado _meta com as informações referente a paginação. Campos retornados:
| Nome | Descrição |
| page | páginas atual |
| totalPages | Quantidade total de páginas |
| totalRecords | Quantidade total de registros |
Exemplo de utilização da paginação:
Retorno
Campos retornados em caso de sucesso:
| Nome | Descrição |
| idintegracao | Array de IDs dos boletos que estão presentes naquele arquivo de remessa. |
| remessa | Link para realização do downlaod da remessa. |
| motivo | Caso a remessa seja rejeitada, esse campo apresenta o motivo |
| situacao |
Situação em que o arquivo de remessa se encontra. As situações possíveis são:
|
| arquivo | Nome do arquivo para controle interno da Tecnospeed, ele não é o mesmo arquivo que foi enviado ao banco. |
| criado | Data de criação do arquivo de remessa. |
| atualizado | Data de atualização, é alterado quando a flag de van pendente é atualizada. |
| vanPendente |
É uma flag que indica que aquele arquivo de remessa deve ser enviado pelo fluxo da VAN mas a Tecnospeed ainda não enviou. |
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"_sucesso": [
{
"idintegracao": [
"abcasd123"
],
"remessa": "https://plugboleto-remessa-production.s3.amazonaws.com/de9775ffe67a5f0f6dd1ad3d046379d7",
"situacao": "GERADA",
"motivo": null,
"arquivo": "COB_237_123456_1347567_00002.rem",
"criado": "2020-07-13T19:04:05.818Z",
"atualizado": "2020-07-13T19:04:05.906Z",
"vanPendente": false
}
]
},
"_meta": {
"page": "1",
"totalPages": 1,
"totalRecords": 1
}
}
Exemplo de retorno com erro:
{
Comentários
0 comentário
Por favor, entre para comentar.