Bunne Docs
Recebíveis

Listar recebíveis.

Lista os recebíveis com escopo do tenant. Exige a permissão receivables:read.

GET
/receivables

Lista os recebíveis com escopo do tenant. Exige a permissão receivables:read.

Autorização

ApiKeyAuth
AutorizaçãoBearer <token>

Em: header

Parâmetros de query

page?integer
Intervalo1 <= value
Padrão1
limit?integer
Intervalo1 <= value <= 100
Padrão50
status?string

Value in

  • "pending"
  • "available"
  • "paid"
  • "canceled"
  • "anticipated"

Corpo da resposta

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/receivables"
{  "object": "list",  "data": [    {      "object": "receivable",      "id": "string",      "charge_id": "string",      "amount_cents": 1,      "gross_amount_cents": 0,      "fee_amount_cents": 0,      "installment": 1,      "installment_count": 1,      "origin": "sale",      "currency": "BRL",      "status": "pending",      "expected_date": "2019-08-24T14:15:22Z",      "paid_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "request_id": "req_xxx",      "assignment_id": "string",      "assignee_public_id": "string"    }  ],  "page": 1,  "limit": 1,  "total": 0,  "total_pages": 0,  "request_id": "req_xxx"}

Listar o histórico (ledger) do saldo do seller. GET

Lista as transações de saldo (lançamentos do ledger) com escopo do tenant para uma API key com escopo de seller, das mais recentes para as mais antigas. Exige a permissão balance:read e uma key com escopo de seller.

Consultar um recebível. GET

Retorna um recebível com escopo do tenant pelo id público. Exige a permissão receivables:read.