> For the complete documentation index, see [llms.txt](https://changelog.maino.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://changelog.maino.com.br/api-reference-maino/07.-contas-bancarias.md).

# 07. 🏦 Contas Bancárias

**Consulta de contas correntes** Visualização de contas correntes cadastradas na empresa. **Funcionalidades:**

* Listagem de contas bancárias
* Consulta de saldos e limites
* Informações de banco e titular

## Consulta o extrato da conta bancária

> \*\*Lista as linhas do extrato bancário da conta num período\*\*\
> \
> Devolve cada linha com a situação de conciliação e os títulos vinculados. Somente leitura.\
> \
> \*\*Período (obrigatório):\*\* \`data\_transacao\_ini\` e \`data\_transacao\_fim\`, no formato\
> \`AAAA-MM-DD\`, com as duas pontas incluídas. A janela máxima deste endpoint é de \*\*90 dias\*\*,\
> contando o dia inicial e o final.\
> \
> \*\*Ordem:\*\* \`data\_transacao\` crescente e, no mesmo dia, \`id\` crescente — estável entre páginas.\
> \
> \*\*Situação (\`status\`):\*\* \`pendente\`, \`conciliado\` ou \`excluido\`. O filtro aceita um ou mais\
> valores separados por vírgula; omitido, devolve as três. Valor desconhecido devolve \*\*400\*\*.\
> \
> \*\*Valor:\*\* sai como registrado na linha. É não negativo nas importações OFX/CSV e nas\
> integrações bancárias, e pode vir negativo em linhas de recebíveis de adquirente de cartão.\
> O sentido vem sempre de \`tipo\_transacao\`.\
> \
> \*\*Títulos vinculados:\*\* uma linha pode ter vários. Cada item traz o tipo, o \`id\` do título e\
> o UUID da conta do título (nulo quando o título não tem conta). Uma linha conciliada por\
> transferência entre contas próprias aparece como \`conciliado\` com a lista vazia. Em caso\
> raro de título excluído que ficou vinculado, o \`id\` pode não ser encontrado pelos GETs de\
> títulos.\
> \
> \*\*Paginação:\*\* \`page\` (padrão 1) e \`per\_page\` (padrão 50, máximo 100).\
> \
> \*\*Permissão:\*\* exige acesso ao extrato bancário.

```json
{"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"07. 🏦 Contas Bancárias","description":"**Consulta de contas correntes**\nVisualização de contas correntes cadastradas na empresa.\n**Funcionalidades:**\n- Listagem de contas bancárias\n- Consulta de saldos e limites\n- Informações de banco e titular"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_correntes/{codigo_conta_corrente}/extrato":{"get":{"summary":"Consulta o extrato da conta bancária","tags":["07. 🏦 Contas Bancárias"],"description":"**Lista as linhas do extrato bancário da conta num período**\n\nDevolve cada linha com a situação de conciliação e os títulos vinculados. Somente leitura.\n\n**Período (obrigatório):** `data_transacao_ini` e `data_transacao_fim`, no formato\n`AAAA-MM-DD`, com as duas pontas incluídas. A janela máxima deste endpoint é de **90 dias**,\ncontando o dia inicial e o final.\n\n**Ordem:** `data_transacao` crescente e, no mesmo dia, `id` crescente — estável entre páginas.\n\n**Situação (`status`):** `pendente`, `conciliado` ou `excluido`. O filtro aceita um ou mais\nvalores separados por vírgula; omitido, devolve as três. Valor desconhecido devolve **400**.\n\n**Valor:** sai como registrado na linha. É não negativo nas importações OFX/CSV e nas\nintegrações bancárias, e pode vir negativo em linhas de recebíveis de adquirente de cartão.\nO sentido vem sempre de `tipo_transacao`.\n\n**Títulos vinculados:** uma linha pode ter vários. Cada item traz o tipo, o `id` do título e\no UUID da conta do título (nulo quando o título não tem conta). Uma linha conciliada por\ntransferência entre contas próprias aparece como `conciliado` com a lista vazia. Em caso\nraro de título excluído que ficou vinculado, o `id` pode não ser encontrado pelos GETs de\ntítulos.\n\n**Paginação:** `page` (padrão 1) e `per_page` (padrão 50, máximo 100).\n\n**Permissão:** exige acesso ao extrato bancário.","parameters":[{"name":"data_transacao_ini","in":"query","required":true,"schema":{"type":"string","format":"date"},"description":"Data inicial, inclusive (AAAA-MM-DD)"},{"name":"data_transacao_fim","in":"query","required":true,"schema":{"type":"string","format":"date"},"description":"Data final, inclusive (AAAA-MM-DD). No máximo 90 dias depois da inicial, contando as duas"},{"name":"status","in":"query","required":false,"schema":{"type":"string"},"description":"Uma ou mais situações separadas por vírgula: pendente, conciliado, excluido"},{"name":"page","in":"query","required":false,"schema":{"type":"integer"},"description":"Número da página (padrão: 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer"},"description":"Linhas por página (padrão: 50; máximo: 100)"}],"responses":{"200":{"description":"Linhas do extrato no período","content":{"application/json":{"schema":{"type":"object","properties":{"linhas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identificador único da linha. Use este campo como chave"},"codigo_conta_corrente":{"type":"string","format":"uuid","description":"UUID da conta bancária da linha"},"identificador":{"type":"string","description":"Número da transação exibido na tela e no extrato do banco. Não é único: não use como chave"},"data_transacao":{"type":"string","format":"date","description":"Data da movimentação (AAAA-MM-DD)"},"valor":{"type":"string","description":"Valor como registrado na linha, em texto decimal. Não é negativo nas importações OFX/CSV e nas integrações bancárias; pode vir negativo em linhas de recebíveis de adquirente de cartão. O sentido da movimentação vem sempre de tipo_transacao"},"tipo_transacao":{"type":"string","enum":["credito","debito"],"description":"Sentido da movimentação"},"status":{"type":"string","enum":["pendente","conciliado","excluido"],"description":"Situação de conciliação. A lista de valores pode crescer: trate valores novos"},"titulos_vinculados":{"type":"array","items":{"type":"object","properties":{"tipo":{"type":"string","enum":["pagamento","recebimento"],"description":"`pagamento` (conta a pagar) ou `recebimento` (conta a receber)"},"id":{"type":"integer","description":"Identificador do título, o mesmo de GET /contas_a_pagars/{id} ou GET /contas_a_recebers/{id}"},"codigo_conta_corrente":{"type":"string","format":"uuid","nullable":true,"description":"UUID da conta bancária do título. Nulo quando o título não tem conta"}}},"description":"Títulos vinculados à linha. Vazio quando a linha não tem título, inclusive conciliada por transferência entre contas próprias"}}}},"pagination":{"type":"object","description":"Metadados de paginação. As chaves de página só aparecem quando existem","properties":{"total":{"type":"integer","description":"Total de linhas no recorte"},"previous_page":{"type":"string","description":"URL da página anterior"},"next_page":{"type":"string","description":"URL da próxima página"}}}}}}}},"400":{"description":"Parâmetro inválido","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"Sem permissão de acesso ao extrato bancário","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"404":{"description":"Conta bancária não encontrada entre as da empresa","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}}}}}}
```

## Consulta o saldo da conta bancária numa data

> \*\*Devolve o saldo da conta bancária ao fim de um dia\*\*\
> \
> Somente leitura. O saldo é o valor em reais ao fim do dia \`data\`, no horário de Brasília: é o\
> mesmo número que o relatório de contas correntes mostra para a mesma data.\
> \
> \*\*Data (opcional):\*\* \`data\` no formato \`AAAA-MM-DD\`. Sem o parâmetro, vale o dia de hoje, e a\
> resposta traz em \`data\` o dia usado. O relatório, por padrão, consulta até o fim do mês\
> seguinte; para comparar os números, informe a mesma data nos dois.\
> \
> \*\*Atualização:\*\* o saldo pode ficar até cerca de 3 minutos atrás de uma baixa recém-feita.\
> \
> \*\*Cálculo:\*\* segue a configuração de saldo da empresa, como a tela.\
> \
> \*\*Datas fora do movimento da conta:\*\*\
> \- data anterior à data do saldo inicial devolve o saldo cadastrado (não é um saldo histórico);\
> \- data futura soma só os lançamentos já liquidados (não inclui previstos).\
> \
> \*\*Conta inativa:\*\* pode ser consultada.\
> \
> \*\*Formato do saldo:\*\* texto decimal com 2 casas e ponto (\`"1150.00"\`, \`"-0.50"\`). Pode ser\
> negativo. Nunca é número de ponto flutuante: leia como texto e converta para decimal.\
> \
> \*\*Permissão:\*\* exige acesso ao relatório de contas correntes.

```json
{"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"07. 🏦 Contas Bancárias","description":"**Consulta de contas correntes**\nVisualização de contas correntes cadastradas na empresa.\n**Funcionalidades:**\n- Listagem de contas bancárias\n- Consulta de saldos e limites\n- Informações de banco e titular"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_correntes/{codigo_conta_corrente}/saldo":{"get":{"summary":"Consulta o saldo da conta bancária numa data","tags":["07. 🏦 Contas Bancárias"],"description":"**Devolve o saldo da conta bancária ao fim de um dia**\n\nSomente leitura. O saldo é o valor em reais ao fim do dia `data`, no horário de Brasília: é o\nmesmo número que o relatório de contas correntes mostra para a mesma data.\n\n**Data (opcional):** `data` no formato `AAAA-MM-DD`. Sem o parâmetro, vale o dia de hoje, e a\nresposta traz em `data` o dia usado. O relatório, por padrão, consulta até o fim do mês\nseguinte; para comparar os números, informe a mesma data nos dois.\n\n**Atualização:** o saldo pode ficar até cerca de 3 minutos atrás de uma baixa recém-feita.\n\n**Cálculo:** segue a configuração de saldo da empresa, como a tela.\n\n**Datas fora do movimento da conta:**\n- data anterior à data do saldo inicial devolve o saldo cadastrado (não é um saldo histórico);\n- data futura soma só os lançamentos já liquidados (não inclui previstos).\n\n**Conta inativa:** pode ser consultada.\n\n**Formato do saldo:** texto decimal com 2 casas e ponto (`\"1150.00\"`, `\"-0.50\"`). Pode ser\nnegativo. Nunca é número de ponto flutuante: leia como texto e converta para decimal.\n\n**Permissão:** exige acesso ao relatório de contas correntes.","parameters":[{"name":"data","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Dia de referência (AAAA-MM-DD). Padrão: hoje, no horário de Brasília"}],"responses":{"200":{"description":"Saldo da conta ao fim do dia","content":{"application/json":{"schema":{"type":"object","required":["codigo_conta_corrente","data","saldo"],"properties":{"codigo_conta_corrente":{"type":"string","format":"uuid","description":"UUID da conta bancária"},"data":{"type":"string","format":"date","description":"Dia de referência usado no cálculo (AAAA-MM-DD)"},"saldo":{"type":"string","pattern":"^-?\\d+\\.\\d{2}$","description":"Saldo em reais ao fim do dia, em texto decimal com 2 casas e ponto. Pode ser negativo"}}}}}},"400":{"description":"Data inválida","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"403":{"description":"Sem permissão de acesso ao relatório de contas correntes","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"404":{"description":"Conta bancária não encontrada entre as da empresa","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}}}}}}
```

## Lista contas bancárias

> Retorna lista de contas bancárias da empresa

```json
{"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"07. 🏦 Contas Bancárias","description":"**Consulta de contas correntes**\nVisualização de contas correntes cadastradas na empresa.\n**Funcionalidades:**\n- Listagem de contas bancárias\n- Consulta de saldos e limites\n- Informações de banco e titular"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_correntes":{"get":{"summary":"Lista contas bancárias","tags":["07. 🏦 Contas Bancárias"],"description":"Retorna lista de contas bancárias da empresa","parameters":[{"name":"page","in":"query","description":"Número da página","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista de contas bancárias","content":{"application/json":{"schema":{"type":"object","properties":{"contas_correntes":{"type":"array","items":{"type":"object","properties":{"codigo_conta_corrente":{"type":"string","description":"UUID da conta bancária","nullable":true},"numero_banco":{"type":"string","description":"Número do banco","nullable":true},"nome_banco":{"type":"string","description":"Nome do banco","nullable":true},"descricao":{"type":"string","description":"Descrição da conta","nullable":true},"agencia":{"type":"string","description":"Agência com dígito","nullable":true},"conta_corrente":{"type":"string","description":"Conta bancária com dígito","nullable":true},"emite_boleto_pjbank":{"type":"boolean","description":"Se emite boleto via PJBank","nullable":true},"ativa":{"type":"boolean","description":"Se a conta está ativa","nullable":true}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total de registros"},"previous_page":{"type":"string","description":"URL da página anterior","nullable":true},"next_page":{"type":"string","description":"URL da próxima página","nullable":true}}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}}
```
