Autenticação: JWT Bearer ou API Key. O usuário precisa ter acesso ao seller informado em
sellers_pk.expected_on. Um recebível é contabilizado quando seu status é pending, paid ou scheduled e possui expected_on preenchido. A tabela interna é recalculada sempre que mudam o status, o valor ou a data prevista do recebível — incluindo a redistribuição para uma conta redirect_sales_to quando o plano de split do seller determina.
Limitado às 90 linhas mais recentes, em ordem decrescente por data.
Este recurso também oferece três ações customizadas: total, next e report.
Requisição
Parâmetros de caminho
UUID da conta unificada do seller.
Parâmetros de consulta
Limite inferior do intervalo de datas previstas (inclusivo).
Limite superior do intervalo de datas previstas (inclusivo).
Resposta
Um array JSON de objetos, ordenado pordate decrescente:
Data prevista de liquidação.
Soma dos valores previstos para a data, em centavos de BRL. Já considera o efeito dos splits de redirecionamento de vendas quando aplicável.
Ações customizadas
GET .../expectedreceivablesbydate/total/
Retorna a soma de todos os recebíveis previstos estritamente posteriores a hoje (no fuso America/Sao_Paulo). Útil para montar um KPI de “total a receber”.
GET .../expectedreceivablesbydate/next/
Retorna o próximo dia útil com liquidação diferente de zero, ignorando finais de semana. Se hoje for dia útil, a busca começa hoje; em sábados/domingos avança para a próxima segunda. A resposta é o primeiro dia cujo total > 0.
GET .../expectedreceivablesbydate/report/?date=YYYY-MM-DD
Dispara um job assíncrono que gera um detalhamento em CSV dos recebíveis previstos para a date informada e envia por e-mail ao chamador. O endpoint retorna imediatamente com 201 e uma mensagem de confirmação.
Data de liquidação a ser relatada. O formato é validado no servidor.
| Status | Quando |
|---|---|
400 | date ausente ou fora do formato YYYY-MM-DD. |
Erros
| Status | Quando |
|---|---|
401 | Cabeçalho Authorization ausente ou inválido. |
403 | Autenticado, porém sem acesso ao seller informado em sellers_pk. |
404 | O UUID do seller não existe. |