Consultar Recebíveis Futuros

Consultar Recebíveis Futuros

get

Retorna recebíveis futuros consolidados por data de execução, com cálculos de desconto aplicados.

Autorizações

ApiKeyAuth

Parâmetros de consulta

idSellerstringObrigatório

ID do vendedor (apenas números de 1 a 999999).

Example: 6198Pattern: ^[1-9][0-9]{0,5}$

executionDateInitialstring · dateObrigatório

Data inicial no formato YYYY-MM-DD.

Example: 2025-01-26

executionDateFinalstring · dateObrigatório

Data final no formato YYYY-MM-DD. Deve ser até 1095 dias maior que data inicial.

Example: 2025-02-26

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API (deve ser o token principal da company).

Respostas

200

Recebíveis futuros retornados com sucesso.

application/json

400

Erro de validação ou parâmetros inválidos.

application/json

403

Token inválido ou acesso negado.

application/json

429

Muitas requisições (limite de 100 por minuto).

application/json

500

Erro interno do servidor.

application/json

get

HTTPcURLJavaScriptPython

GET /v2/report/receivables/future HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*

{
  "data": {
    "summary": {
      "totalDays": 42,
      "totalNet": 73419.52,
      "averageDailyAmount": 1748.08
    },
    "receivables": [
      {
        "date": "2025-01-26",
        "daysUntilExecution": 0,
        "amounts": {
          "netCredit": 1764.07,
          "netDebit": 40.49,
          "totalNet": 1723.58,
          "finalAmount": 1723.58
        }
      },
      {
        "date": "2025-01-27",
        "daysUntilExecution": 1,
        "amounts": {
          "netCredit": 1064.13,
          "netDebit": 26.34,
          "totalNet": 1037.79,
          "finalAmount": 1036.75
        }
      }
    ]
  }
}