# Financeiro A API de Financeiro tem como objetivo oferecer um conjunto de recursos para gerenciar de forma programática os principais aspectos financeiros de uma empresa, desde a criação de eventos de contas a receber ou pagar, passando pela gestão de contas financeiras, centros de custo, categorias, até a consulta de saldos. Com esta API, sistemas podem integrar de forma fluida com o módulo financeiro da Conta Azul, garantindo que lançamentos, saldos, classificações e relatórios estejam sempre sincronizados. Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda: **Contas a pagar e receber:** [https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar](https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar) **Cadastro e gestão de contas financeiras:** [https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras](https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras) **Categorias financeiras e centro de custos:** [https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo](https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo) Version: v1 ## Servers Servidor de produção ``` https://api-v2.contaazul.com ``` ## Security ### BearerAuth Token de autorização Bearer JWT Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Financeiro](https://developers.contaazul.com/_bundle/docs/financial-apis-openapi.yaml) ## v1 Conjunto de recursos para acompanhar e administrar as finanças da empresa - esses recursos incluem centros de custo, parcelas, categorias, categorias dre, contas financeiras e movimentações (contas a pagar e a receber) ### Retornar os centros de custo por filtro - [GET /v1/centro-de-custo](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchcostcenters.md): Permite consultar os centros de custo cadastrados. Suporta filtros como página, tamanho de página, busca por texto, status (ativo/inativo/todos) e ordenação. Utilizado para consultar lançamentos financeiros e facilitar análise orçamentária. ### Criar um novo centro de custo - [POST /v1/centro-de-custo](https://developers.contaazul.com/docs/financial-apis-openapi/v1/createcostcenter.md): Permite criar um novo centro de custo, definindo campos como código, nome, parâmetros que ajudam a organizar os custos da empresa de forma estruturada. ### Retornar as parcelas pelo id do evento financeiro - [GET /v1/financeiro/eventos-financeiros/{id_evento}/parcelas](https://developers.contaazul.com/docs/financial-apis-openapi/v1/getinstallmentsbyeventid.md): Permite listar as parcelas vinculadas a um evento financeiro específico (id_evento). Útil para acompanhar cada parcela de um lançamento de contas a pagar ou receber, com seus valores, vencimentos e status e outras informações pertinentes. ### Retornar as categorias por filtro - [GET /v1/categorias](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchcategories.md): Permite listar as categorias utilizadas para classificação de receitas ou despesas. Auxilia no controle, agrupamento e geração de relatórios financeiros baseados em categorias. ### Retornar as categorias DRE - [GET /v1/financeiro/categorias-dre](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchdrecategories.md): Permite listar as categorias de DRE (Demonstração do Resultado do Exercício) usadas para a estrutura contábil-financeira da empresa, facilitando o fechamento financeiro e contábil. ### Retornar as contas financeiras por filtro - [GET /v1/conta-financeira](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchfinancialaccounts.md): 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. ### Retornar o saldo atual pelo id da conta financeira - [GET /v1/conta-financeira/{id_conta_financeira}/saldo-atual](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchbalancebyfinancialaccountid.md): Permite obter o saldo atual de uma conta financeira específica identificada por id_conta_financeira. Útil para monitoramento em tempo real de saldos das contas da empresa. ### Retornar as transferências entre contas financeiras por filtro - [GET /v1/financeiro/transferencias](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchaccountingexporttransfers.md): Permite consultar as transferências realizadas entre contas financeiras mediante filtros como período de datas e contas financeiras específicas. Para viabilizar a conciliação financeira automática e sincronizar corretamente as movimentações no meu sistema. ### Criar um novo evento financeiro de contas a receber - [POST /v1/financeiro/eventos-financeiros/contas-a-receber](https://developers.contaazul.com/docs/financial-apis-openapi/v1/createreceivablefinancialevent.md): Permite criar um novo evento financeiro de contas a receber, passando dados como data de competência, valor, descrição, conta financeira, condições de pagamento, entre outros. Facilita o registro de receitas previstas ou realizadas. ### Retornar as receitas por filtro - [GET /v1/financeiro/eventos-financeiros/contas-a-receber/buscar](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchinstallmentstoreceivebyfilter.md): Permite consultar as parcelas de receitas (contas a receber) mediante filtros como data de vencimento, data de competência, data de pagamento, data de alteração, valor, status, dentre outros. Essa funcionalidade ajuda no controle e análise de entradas financeiras com base nas condições definidas. ### Criar um novo evento financeiro de contas a pagar - [POST /v1/financeiro/eventos-financeiros/contas-a-pagar](https://developers.contaazul.com/docs/financial-apis-openapi/v1/createpayablefinancialevent.md): Permite criar um novo evento financeiro de contas a pagar, informando dados como valor, condições de pagamento, descrição, conta financeira, entre outros. Esse endpoint facilita o registro das obrigações financeiras da empresa. ### Retornar as despesas por filtro - [GET /v1/financeiro/eventos-financeiros/contas-a-pagar/buscar](https://developers.contaazul.com/docs/financial-apis-openapi/v1/searchinstallmentstopaybyfilter.md): Permite consultar as parcelas de despesas (contas a pagar) conforme filtros como data de vencimento, data competência, data de alteração, valor, status, conta financeira, etc. Essa consulta possibilita monitorar as obrigações financeiras pendentes ou pagas, favorecendo a gestão e o planejamento. ### Retornar a parcela por id - [GET /v1/financeiro/eventos-financeiros/parcelas/{id}](https://developers.contaazul.com/docs/financial-apis-openapi/v1/getinstallmentbyid.md): Permite consultar os detalhes de uma parcela específica (de conta a receber ou a pagar) identificada pelo seu id. A resposta traz campos como data de vencimento, valor, status, conta financeira, entre outros. ### Atualizar parcialmente uma parcela por id - [PATCH /v1/financeiro/eventos-financeiros/parcelas/{id}](https://developers.contaazul.com/docs/financial-apis-openapi/v1/updateinstallment.md): Permite atualizar parcialmente uma parcela existente identificada pelo id, alterando campos como data de vencimento, valor, observações, conta financeira e outros campos permitidos. Essa operação ajuda a ajustar lançamentos financeiros sem a necessidade de recriá-los. ### Retornar os IDs dos eventos financeiros alterados em um período - [GET /v1/financeiro/eventos-financeiros/alteracoes](https://developers.contaazul.com/docs/financial-apis-openapi/v1/getalteredfinancialevents.md): Permite consultar os IDs dos eventos financeiros (contas a pagar e a receber) que foram alterados em um período definido por data de ínico e fim. Essa funcionalidade é útil para identificar quais eventos sofreram modificações recentes, facilitando a sincronização e o monitoramento de mudanças nos dados financeiros. Importante: As informações disponíveis indicam a data e hora em que o evento foi salvo, sem detalhar quais campos foram modificados em cada operação. Salvar um recurso sem alterações reais pode gerar uma entrada no histórico e atualizar a data do último registro. ### Retornar os saldos iniciais das contas financeiras - [GET /v1/financeiro/eventos-financeiros/saldo-inicial](https://developers.contaazul.com/docs/financial-apis-openapi/v1/getinitialbalancesoffinancialaccounts.md): Permite consultar os saldos iniciais das contas financeiras em um período definido por data de início e fim.