For the complete documentation index, see llms.txt. This page is also available as Markdown.

Detalhar Recebíveis do Vendedor

Detalhes de recebíveis do seller

get

Retorna os detalhes dos recebíveis de um seller específico

Authorizations
x-token-apistringRequired

Token de API obrigatório para autenticação

Path parameters
sellerIdstringRequired

ID do Seller

Example: 123456
Query parameters
datestring · dateRequired

Data para consulta dos recebíveis (formato YYYY-MM-DD)

Example: 2026-02-01
pageintegerOptional

Número da página para paginação

Example: 1
limitintegerOptional

Quantidade de itens por página

Example: 10
Responses
200

Resposta bem-sucedida

application/json
pageintegerOptional

Número da página atual

Example: 1
limitintegerOptional

Quantidade de itens por página

Example: 10
total_pageintegerOptional

Total de páginas

Example: 13
total_recordsintegerOptional

Total de registros

Example: 129
has_prevbooleanOptional

Indica se existe página anterior

Example: false
has_nextbooleanOptional

Indica se existe próxima página

Example: true
datestring · dateOptional

Data da consulta

Example: 2025-12-17
expected_total_amountnumber · floatOptional

Valor total esperado

Example: 5000.25
get/v2/seller/{sellerId}/receivables/details
GET /v2/seller/{sellerId}/receivables/details?date=2026-02-01 HTTP/1.1
Host: api.barte.com
x-token-api: YOUR_API_KEY
Accept: */*
{
  "page": 1,
  "limit": 10,
  "total_page": 5,
  "total_records": 42,
  "has_prev": false,
  "has_next": true,
  "date": "2025-12-17",
  "expected_total_amount": 5432.5,
  "receivables": [
    {
      "expected_gross_amount": 1250,
      "expected_net_amount": 1125,
      "execution_date": "2025-12-17",
      "charge_uuid": "12345678-1234-1234-1234-123456789012",
      "installment": 3,
      "statement_description": "Loja Exemplo - Compra parcelada",
      "details": [
        {
          "type": "CREDIT",
          "description": "Pagamento cartão crédito",
          "statement_uuid": "87654321-4321-4321-4321-210987654321",
          "amount": 1250
        },
        {
          "type": "DEBIT",
          "description": "Taxa administrativa",
          "statement_uuid": "11111111-2222-3333-4444-555555555555",
          "amount": 125
        }
      ]
    }
  ]
}

Last updated

Was this helpful?