Endpoint: GET /unified/accounts/sellers/{sellers_pk}/metrics/accountexpectedreceivablescomparison/
Autenticação: JWT Bearer ou API Key. O usuário precisa ter acesso ao seller informado em sellers_pk.
Mesma ideia do accountsalescomparison, porém a fonte é a tabela de recebíveis previstos por conta em vez das vendas por data. As linhas são agrupadas pela conta da transação que originou o recebível futuro. A janela de período anterior é derivada da janela atual da mesma forma:
  • current_start = date_before, current_end = date_after.
  • period_length = current_end - current_start.
  • previous_start = current_start - (period_length + 1) dias.
  • previous_end = current_start - 1 dia.
Atenção: os nomes date_after e date_before aparecem invertidos em relação a outros endpoints de métricas. Aqui date_after é o fim do período atual e date_before é o início do período atual. Ambos são obrigatórios; se algum estiver ausente, o endpoint retorna lista vazia (sem erro).
As linhas são ordenadas por current_period_total decrescente e o resultado é paginado por número de página.

Requisição

Parâmetros de caminho

sellers_pk
string
required
UUID da conta unificada do seller destinatário.

Parâmetros de consulta

date_after
string (YYYY-MM-DD)
required
Fim do período atual.
date_before
string (YYYY-MM-DD)
required
Início do período atual.
page
integer
Número da página, começando em 1.
page_size
integer
Quantidade de itens por página.

Resposta

Linhas de comparação paginadas:
account
object
Conta da transação que contribui com os recebíveis previstos.
  • id, display_name, type.
current_period_total
integer
Soma dos valores previstos atribuíveis à conta no período atual, em centavos de BRL.
previous_period_total
integer
Mesma soma para o período anterior, em centavos de BRL.
change_amount
integer
current_period_total - previous_period_total, em centavos de BRL.
change_percentage
number
Arredondado para duas casas decimais. 100.0 quando o período anterior foi zero e o atual é positivo; 0.0 quando ambos forem zero.
{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "account": {
        "id": "8c2d7f6e9b4a4f10aabbccddeeff0011",
        "display_name": "Acme Sub-Seller 01",
        "type": "business"
      },
      "current_period_total": 2000000,
      "previous_period_total": 1500000,
      "change_amount": 500000,
      "change_percentage": 33.33
    }
  ]
}

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/accountexpectedreceivablescomparison/?date_after=2025-05-14&date_before=2025-05-01" \
  -H "Authorization: Bearer $TOKEN"