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

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

Parâmetros de consulta

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

Resposta

Linhas de comparação paginadas:
object
Conta da transação que contribui com os recebíveis previstos.
  • id, display_name, type.
integer
Soma dos valores previstos atribuíveis à conta no período atual, em centavos de BRL.
integer
Mesma soma para o período anterior, em centavos de BRL.
integer
current_period_total - previous_period_total, em centavos de BRL.
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.

Erros

Exemplos