Retornar as contas financeiras por filtro

Request

Permite consultar as contas financeiras existentes no sistema (contas bancárias, cartões, poupança, etc.). Suporta filtros como tipo de conta, nome, se estão ativas, entre outros.

Security

BearerAuth

Query

paginainteger

Página

Default:1

Example:pagina=1

tamanho_paginainteger

Tamanho da página

Enum:1020501002005001000

Example:tamanho_pagina=10

tiposArray of strings

Lista de tipos de conta

Items Enum:"APLICACAO""CAIXINHA""CONTA_CORRENTE""CARTAO_CREDITO""INVESTIMENTO""OUTROS""MEIOS_RECEBIMENTO""POUPANCA""COBRANCAS_CONTA_AZUL""RECEBA_FACIL_CARTAO"

Example:tipos=APLICACAO

nomestring

Nome da conta

Example:nome=Conta corrente

apenas_ativoboolean

Filtrar apenas contas ativas

Example:apenas_ativo=true

esconde_conta_digitalboolean

Esconder contas digitais

Example:esconde_conta_digital=true

mostrar_caixinhaboolean

Mostrar contas de caixinha

Example:mostrar_caixinha=true

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/conta-financeira?pagina=1&tamanho_pagina=10&tipos=APLICACAO&nome=Conta%20corrente&apenas_ativo=true&esconde_conta_digital=true&mostrar_caixinha=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

itens_totaisinteger

Example:6

itensArray of objects(ContaFinanceira)

totaisobject(Totais)

Response

{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}