1.2. Introdução
Lotes de Cessão¶
Todo o envio de títulos para o fundo ocorre por meio de lotes. O fluxo de cessão segue três etapas principais:
- Criar o lote de cessão.
- Adicionar os títulos ao lote.
- Enviar o lote para processamento no fundo.
Também é possível remover títulos antes do envio do lote, quando a operação ainda permitir manutenção.
Lotes de Liquidação¶
O envio de liquidações também ocorre por meio de lotes. O fluxo de liquidação segue três etapas principais:
- Criar o lote de liquidação.
- Adicionar as liquidações ao lote.
- Enviar o lote para processamento no fundo.
Consultas¶
A API pública permite consultar:
| Recurso | Endpoint |
|---|---|
| Lote por identificador | GET /public/v1/recebiveis/lotes/{idLote} |
| Títulos de um lote | GET /public/v1/recebiveis/lotes/{idLote}/titulos |
| Títulos disponíveis em estoque | GET /public/v1/recebiveis/titulos |
| Título por identificador | GET /public/v1/recebiveis/titulos/{id} |
| Volume em aberto por cedente ou por sacado | GET /public/v1/recebiveis/titulos/volume-em-aberto/cedente, .../volume-em-aberto/sacado |
| Volume em aberto de um cedente, pelo CPF ou CNPJ | GET /public/v1/recebiveis/titulos/volume-em-aberto/cedente/por-documento/{cpfCnpj} |
| Patrimônio líquido dos fundos | GET /public/api/v1/patrimonio-liquido |
| Valor disponível para movimentação dos fundos | GET /public/api/v1/valor-disponivel-movimentacao |
Manutenção de Lotes¶
Quando necessário, um lote pode ser cancelado pelo endpoint:
| Recurso | Endpoint |
|---|---|
| Cancelar lote | POST /public/v1/recebiveis/lotes/{idLote}/cancelar |
| Reenviar o arquivo do lote ao fundo depois de uma falha de envio | POST /public/v1/recebiveis/lotes/{idLote}/reenviar-arquivo-fundo |
Conforme a configuração da operação, o cancelamento exclui os títulos do lote e pode liberar o reenvio do arquivo que os importou — veja as regras em Cancelar Lote.
Documentos do Título¶
Além do lastro principal (o documento fiscal), cada título pode ter documentos adicionais — contrato mestre, termo de utilização. Eles são anexados, consultados e removidos pelos endpoints:
| Recurso | Endpoint |
|---|---|
| Listar os documentos do título | GET /public/v1/recebiveis/titulos/{id}/documentos |
| Anexar documento a títulos pelo id | POST /public/v1/recebiveis/titulos/documentos |
| Anexar documento a títulos pelo id (base64) | POST /public/v1/recebiveis/titulos/documentos/base64 |
| Anexar documento pela chave do lastro | POST /public/v1/recebiveis/lotes/{idOperacao}/lastros/avulsos/chave/{chave} |
| Baixar o arquivo de um documento | GET /public/v1/recebiveis/titulos/{id}/documentos/{idLastro}/arquivo |
| Desvincular um documento adicional | DELETE /public/v1/recebiveis/titulos/{id}/documentos/{idLastro} |
Leitura do Bucket da Administradora¶
Nas operações em que a administradora devolve retornos e relatórios num bucket, as pastas lidas e os arquivos processados são acompanhados pelos endpoints:
| Recurso | Endpoint |
|---|---|
Conectores do grupo econômico (sem credenciais), de onde sai o idConector das pastas | GET /public/api/v1/operacoes/{idOperacao}/conectores |
| Conexões de envio da operação (sem credenciais) | GET /public/api/v1/operacoes/{idOperacao}/configuracoes-envio-arquivo |
| Pastas de leitura do bucket | GET / POST /public/api/v1/operacoes/{idOperacao}/configuracoes-leitura-arquivo, PUT .../{id} |
| Arquivos lidos do bucket | GET /public/api/v1/operacoes/{idOperacao}/arquivos-lidos-bucket |
| Ler de novo um arquivo que falhou | POST /public/api/v1/operacoes/{idOperacao}/arquivos-lidos-bucket/{id}/reprocessar |