v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Extrato Financeiro

Retorna o extrato financeiro de uma conta.

<div class="magic-block-callout type-warning"><h3><i title="Warning" class="fa fa-exclamation-circle"></i>Atenção</h3><div class="callout-body"><p>Esta API obriga a utilização do <code>live_api_token</code> na autenticação da chamada. Somente em modo "produção" há movimentação de saldo na conta iugu.</p></div></div>

get/accounts/financial

Query parameters

yearstring

Ano

monthstring

Mês

daystring

Dia

limitinteger

Limita em até 1.000 o número de registros listados. Embora recomendamos usar no máximo limit=100

startinteger

Quantos registros pular do início da pesquisa, usado para paginação. (ver no inicio da documentação)

hlstring

Define o locale para formatação de valor. Pode ser "en" ou "pt-BR"

Response

200

initial_datestring

final_datestring

transactions_totalinteger

Example response

{
  "transactions": [
    {
      "amount": "R$ 1,00",
      "type": "credit",
      "description": "Pagamento recebido: Fatura #4C6A54F52FF04A969A9170ABA3C9C710",
      "entry_date": "2024-04-08",
      "reference": "4C6A54F52FF04A969A9170ABA3C9C710",
      "reference_type": "Invoice",
      "account_id": "27016E1AD888499A98994E781B6C3762",
      "transaction_type": "misc",
      "invoice_email": "js@email.com",
      "amount_cents": "100.0",
      "balance": "R$ 2,61",
      "balance_cents": "261.0",
      "customer_ref": "js@email.com"
    }
  ],
  "initial_balance": {
    "amount": "R$ 1,61",
    "amount_cents": "161.0",
    "entry_date": "2024-03-31"
  },
  "initial_date": "2024-03-31T00:00:00-03:00",
  "final_date": "2024-04-30T13:12:04-03:00",
  "transactions_total": 4
}