v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Listar Recebíveis

Lista Recebíveis de uma conta

get/financial_transaction_requests

Query parameters

limitinteger

Quantidade de recebíveis retornadas (recomendamos usar no máximo limit=100)

startinteger

Quantos registros pular do início da pesquisa, usado para paginação (verificar modo de uso em Paginação)

status_filterstring

Lista recebíveis filtrando por status (pending, done ou canceled)

since[year]integer

Filtrar registros a partir de determinado ano

since[month]integer

Filtrar registros a partir de determinado mês

since[day]integer

Filtrar registros a partir de determinado dia

to[year]integer

Filtrar registros até determinado ano

to[month]integer

Filtrar registros até determinado mês

to[day]integer

Filtrar registros até determinado dia

Response

200

totalItemsinteger

Example response

{
  "items": [
    {
      "id": 164913709,
      "description": "Fatura 3D6620BF8352449CB0F2BDB3ADC368B1 Parcela: Unica",
      "scheduled_date": "2025-05-28",
      "transaction_code": "MCC",
      "installment": 1,
      "status": "pending",
      "invoice_id": "3D6620BF8352449CB0F2BDB3ADC368B1",
      "customer_ref": "email@iugu.com",
      "total": "R$ 5,00",
      "taxes": "R$ 0,65",
      "client_share": "R$ 4,35",
      "commission": "R$ 0,00",
      "advance_fee": "R$ 0,07",
      "estimated_advance_fee": {
        "fractional": "7.0",
        "currency": {
          "id": "brl",
          "decimal_mark": ",",
          "html_entity": "R$",
          "iso_code": "BRL",
          "iso_numeric": "986",
          "name": "Brazilian Real",
          "priority": 100,
          "smallest_denomination": 5,
          "subunit": "Centavo",
          "subunit_to_unit": 100,
          "symbol": "R$",
          "symbol_first": true,
          "thousands_separator": "."
        }
      },
      "total_cents": 500,
      "taxes_cents": 65,
      "client_share_cents": 435,
      "number_of_installments": 1,
      "created_at": "2025-04-28T16:04:22-03:00",
      "updated_at": "2025-04-28T16:04:22-03:00",
      "advanceable": true
    }
  ],
  "totalItems": 1
}