Skip to content

Retornar as contas financeiras por filtro

Request

Security
BearerAuth
Query
paginainteger, >= 1

Número da página

Default:1
tamanho_paginainteger, [ 1 .. 1000 ]

Tamanho da página

Default:10
campo_ordenado_ascendentestring

Ordenação ascendente

Value:"NOME"
campo_ordenado_descendentestring

Ordenação descendente

Value:"NOME"
tiposArray of strings

Tipos de conta financeira, separados por vírgula ou repetindo o parâmetro

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

Nome da conta financeira

apenas_ativoboolean

Filtrar apenas contas ativas

esconde_conta_digitalboolean

Esconder contas digitais

mostrar_caixinhaboolean

Mostrar contas de caixa

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/financeiro/contas-financeiras?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=NOME&campo_ordenado_descendente=NOME&tipos=APLICACAO&nome=string&apenas_ativo=true&esconde_conta_digital=true&mostrar_caixinha=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itensArray of objects(ContaFinanceira)

lista de contas financeiras

itens_totaisinteger

total de itens na resposta

Example:150
Response
{ "itens": [ { … } ], "itens_totais": 150 }