Endpoint: GET /unified/accounts/sellers/{sellers_pk}/metrics/expectedreceivablesbydate/
Autenticação: JWT Bearer ou API Key. O usuário precisa ter acesso ao seller informado em sellers_pk.
Retorna a entrada de caixa prevista (futura) do seller, agrupada por data em 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

sellers_pk
string
required
UUID da conta unificada do seller.

Parâmetros de consulta

date_after
string (YYYY-MM-DD)
Limite inferior do intervalo de datas previstas (inclusivo).
date_before
string (YYYY-MM-DD)
Limite superior do intervalo de datas previstas (inclusivo).

Resposta

Um array JSON de objetos, ordenado por date decrescente:
date
string (YYYY-MM-DD)
Data prevista de liquidação.
total
integer
Soma dos valores previstos para a data, em centavos de BRL. Já considera o efeito dos splits de redirecionamento de vendas quando aplicável.
[
  { "date": "2025-06-15", "total": 1500000 },
  { "date": "2025-06-14", "total": 845000 }
]

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”.
{ "total": 32450000 }

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.
{ "date": "2025-05-15", "total": 1284500 }
Quando não há liquidação futura prevista:
{ "date": null, "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.
date
string (YYYY-MM-DD)
required
Data de liquidação a ser relatada. O formato é validado no servidor.
{ "message": "Report job launched. The CSV will be sent to your email." }
StatusQuando
400date ausente ou fora do formato YYYY-MM-DD.

Erros

StatusQuando
401Cabeçalho Authorization ausente ou inválido.
403Autenticado, porém sem acesso ao seller informado em sellers_pk.
404O UUID do seller não existe.

Exemplos

curl https://api.dlpay.cloud/unified/accounts/sellers/{sellers_pk}/metrics/expectedreceivablesbydate/ \
  -H "Authorization: Bearer $TOKEN"