Pular para o conteúdo
Pagamentos

Agenda de recebíveis

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/receivables
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.read

Fluxo de caixa do recebedor: cada parcela a creditar (ou já creditada) no período creditFrom–creditTo (YYYY-MM-DD, até 366 dias), com bruto, taxa e líquido reais, situação e data do crédito. Estornos e contestações entram com valor negativo. Filtros por status, kind e chargeId.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • creditFromstringobrigatório

    Início do período pela data PREVISTA de crédito (YYYY-MM-DD).

    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • creditTostringobrigatório

    Fim do período (inclusivo), até 366 dias depois do início.

    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • statusstringopcional

    Situação do crédito na agenda do processador.

    • um de"scheduled""processing""partially_credited""credited""failed"
  • kindstringopcional
    • um de"sale""refund""refund_reversal""chargeback""chargeback_reversal"
  • chargeIdstringopcional
  • cursorstringopcional
  • limitintegeropcional
    • padrão 50
    • faixa 1–200

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A agenda de crédito do período, pela data PREVISTA, da mais próxima para a mais distante.

  • Cada item — V1Receivable

    • idstring
    • chargeIdstring | null

      Cobrança de origem; null para lançamento sem cobrança local.

    • contactIdstring | null
    • kindstring

      sale é a parcela da venda; os demais entram com valor negativo (ou positivo, na reversão).

      • um de"sale""refund""refund_reversal""chargeback""chargeback_reversal"
    • installmentNumberinteger | null
    • totalInstallmentsinteger | null
    • amountinteger

      Bruto com sinal, em centavos: crédito +, débito −.

    • platformFeeinteger | null

      Taxa real da mesma parcela, em centavos (positivo); null quando não informada.

    • netAmountinteger
    • creditedAmountinteger
    • pendingAmountinteger
    • statusstring

      Situação do crédito na agenda do processador.

      • um de"scheduled""processing""partially_credited""credited""failed"
    • estimatedCreditDatestring

      Data prevista do crédito (YYYY-MM-DD).

    • creditDatestring | null

      Quando o dinheiro entrou (ISO); null até entrar.

  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.

  • countinteger

    Total de linhas do filtro, em todas as páginas.