How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Conta Azul v1 API

Conjunto de recursos para acompanhar e administrar operações relacionadas ao gerenciamento de baixas - esses recursos incluem criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa por id, deletar baixa por id e retornar a baixa por id

Conta Azul v1 API is one of 2 APIs that Conta Azul publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include v1. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 49 operations across 38 paths, and defines 173 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api-v2.contaazul.com.

49 operations 38 paths 173 schemas 5 DELETE29 GET2 PATCH12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api-v2.contaazul.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Conta Azul v1 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Token de autorização Bearer JWT

Paths & Operations 49

Across 38 paths, the API surfaces 49 operations — 5 DELETE, 29 GET, 2 PATCH, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

v1 49

Conjunto de recursos para acompanhar e administrar operações relacionadas ao gerenciamento de baixas - esses recursos incluem criar uma nova baixa, retornar as baixas pelo id da p…

POST
/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa
Criar uma nova baixa
criarBaixa 1 param body → 200400401429500
GET
/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa
Retornar as baixas pelo id da parcela
listarBaixas 1 param → 200400401429500
PATCH
/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}
Atualizar parcialmente uma baixa por id
atualizarBaixa 1 param body → 200400401429500
DELETE
/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}
Deletar baixa por id
deletarBaixa 1 param → 200400401404429500
GET
/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}
Retornar a baixa por id
buscarBaixa 1 param → 200400401404429500
GET
/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}
Retornar a cobrança por id
buscarCobrancaPorId 1 param → 200400401404429500
DELETE
/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}
Deletar cobrança por id
deletarCobrancaPorId 1 param → 200400401404429500
POST
/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca
Criar uma nova cobrança
criarCobranca body → 200400401429500
POST
/v1/contratos
Criar um novo contrato
criarContrato body → 200400401429500
GET
/v1/contratos
Retornar os contratos por filtro
listarContratos 8 params → 200400401429500
GET
/v1/contratos/proximo-numero
Retornar o próximo número do contrato disponível
getNextContractNumber → 200400401429500
GET
/v1/centro-de-custo
Retornar os centros de custo por filtro
searchCostCenters 6 params → 200400401429500
POST
/v1/centro-de-custo
Criar um novo centro de custo
createCostCenter body → 200400401429500
GET
/v1/financeiro/eventos-financeiros/{id_evento}/parcelas
Retornar as parcelas pelo id do evento financeiro
getInstallmentsByEventId 1 param → 200400401429500
GET
/v1/categorias
Retornar as categorias por filtro
searchCategories 9 params → 200400401429500
GET
/v1/categorias/configuracao-padrao
Retornar a configuração de de-para de categorias
getDefaultCategoryConfig 1 param → 200400401429500
GET
/v1/financeiro/categorias-dre
Retornar as categorias DRE
searchDreCategories → 200401429500
GET
/v1/conta-financeira
Retornar as contas financeiras por filtro
searchFinancialAccounts 7 params → 200400401429500
GET
/v1/conta-financeira/{id_conta_financeira}/saldo-atual
Retornar o saldo atual pelo id da conta financeira
searchBalanceByFinancialAccountId 1 param → 200400401429500
GET
/v1/financeiro/transferencias
Retornar as transferências entre contas financeiras por filtro
searchAccountingExportTransfers 5 params → 200400401429500
POST
/v1/financeiro/eventos-financeiros/contas-a-receber
Criar um novo evento financeiro de contas a receber
createReceivableFinancialEvent body → 202400401429500
GET
/v1/financeiro/eventos-financeiros/contas-a-receber/buscar
Retornar as receitas por filtro
searchInstallmentsToReceiveByFilter 20 params → 200400401429500
POST
/v1/financeiro/eventos-financeiros/contas-a-pagar
Criar um novo evento financeiro de contas a pagar
createPayableFinancialEvent body → 202400401429500
GET
/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar
Retornar as despesas por filtro
searchInstallmentsToPayByFilter 19 params → 200400401429500
GET
/v1/financeiro/eventos-financeiros/parcelas/{id}
Retornar a parcela por id
getInstallmentById 1 param → 200400401429500
PATCH
/v1/financeiro/eventos-financeiros/parcelas/{id}
Atualizar parcialmente uma parcela por id
updateInstallment 1 param body → 200400401429500
GET
/v1/financeiro/eventos-financeiros/alteracoes
Retornar os IDs dos eventos financeiros alterados em um período
getAlteredFinancialEvents 4 params → 200400401429500
GET
/v1/financeiro/eventos-financeiros/saldo-inicial
Retornar os saldos iniciais das contas financeiras
getInitialBalancesOfFinancialAccounts 4 params → 200400401429500
GET
/v1/produto/busca
Obter produtos por filtro
getProductsByFilter 8 params → 200
POST
/v1/produto
Criar um novo produto
createProduct body → 200
DELETE
/v1/produto/{id}
Excluir um produto existente
deleteProduct 1 param → 204404
POST
/v1/produto/desativar
Desativar produtos
deactivateProducts body → 200400500
GET
/v1/orcamentos
Retornar orçamentos por filtros
listarOrcamentosPorFiltros 22 params → 200400401429500
POST
/v1/orcamentos
Criar um orçamento
criarOrcamento body → 201400401429500
DELETE
/v1/orcamentos
Excluir orçamentos em lote
excluirOrcamentosEmLote body → 204400401429500
GET
/v1/orcamentos/{id}
Retornar o orçamento por ID
obterOrcamentoPorID 1 param → 200400401404429500
GET
/v1/protocolo/{id}
Retornar o protocolo por id
buscarProtocoloPorId 1 param → 200400401404429500
GET
/v1/venda/vendedores
Retornar os vendedores
listVendedores → 200400401429500
GET
/v1/venda/{id}
Retornar a venda por id
getVendaById 1 param → 200400401404429500
PUT
/v1/venda/{id}
Atualizar uma venda por id
editSale 1 param body → 200400401429500
GET
/v1/venda/busca
Retornar as vendas por filtro
searchVendas 26 params → 200400401429500
POST
/v1/venda
Criar uma nova venda
createVenda body → 200400401429500
GET
/v1/venda/{id}/imprimir
Retornar o PDF de uma venda
printVendaPdf 1 param → 200400401404429500
POST
/v1/venda/exclusao-lote
Excluir vendas em lote
deleteVendasBatch body → 200400401429500
GET
/v1/venda/{id_venda}/itens
Retornar os itens de uma venda pelo id da venda
getVendaItens 3 params → 200400401404429500
GET
/v1/venda/proximo-numero
Retornar o próximo número de venda disponível
getNextVendaNumber → 200400401429500
GET
/v1/contratos/{id}
Retornar o contrato por id
obterContratoPorID 1 param → 200400401404429500
DELETE
/v1/contratos/{id}
Remover um contrato
removerContrato 1 param → 204400401429500
POST
/v1/contratos/{id}/encerrar
Encerrar um contrato
encerrarContrato 1 param → 204400401429500

Schemas 173

The contract defines 173 schemas that model the data the API accepts and returns. The most detailed are Parcela (30 properties), Negociacao (20 properties), SolicitacaoCobranca (19 properties), ProductListResponse (18 properties). Each schema is shown below with its type and property counts.

SaldoAtualResponse
object
Saldo atual da conta financeira
1 property
ComposicaoValor_2
object
8 properties
ParcelaAtualizacaoRequest
object
11 properties 1 required
DescontoOrcamento
object
Modelo que representa o desconto de um orçamento
2 properties
Evento
object
8 properties
AnexoBaixa
object
7 properties
TipoDePagamento
string
Enum de tipo de pagamento
BaixaCriacaoRequestDTO
object
6 properties 3 required
ItensTotaisNegociacao
object
3 properties
ProductVariationOptionRequest
object
2 properties 2 required
Ecommerce
object
6 properties
ProtocolResponseDTO_2
object
4 properties
ComposicaoDeValor
object
2 properties
ContratoResumo
object
Resumo do modelo que representa um contrato de venda recorrente
15 properties
ConfiguracaoDesconto
object
2 properties
CriacaoProdutoRequest
object
9 properties 4 required
ClientePegarVendaPorId
object
4 properties
ObterVendaResponse
object
7 properties
ClienteOrcamento
object
3 properties
VendedorResumo
object
Resumo dos dados do vendedor responsável pelo contrato
2 properties
ContaAReceber
object
15 properties
CategoriaDRE
object
8 properties
ValorComposicaoRequest
object
2 properties
Estoque
object
6 properties
CondicaoPagamento_3
object
8 properties
Status_2
string
Enum de status do contrato
Notificacao
object
5 properties
EcommerceRequestProduto
object
6 properties
ItemKitRequest
object
4 properties 4 required
ParcelaCondicaoPagamento
object
6 properties 5 required
GerarCobrancaResponseDto
object
3 properties
Desconto
object
2 properties 2 required
CriacaoVendaResponse
object
14 properties
CondicaoPagamento_2
object
2 properties
ContratoToCreateRequest
object
11 properties 4 required
Totais
object
3 properties
ContasAReceberResponse
object
3 properties
Item
object
5 properties 3 required
ComposicaoValorResponse
object
4 properties
ConfiguracaoPadraoCategoria
object
Item do de-para entre uma operação financeira e a categoria configurada para o tenant
4 properties
TipoItemOrcamento
string
Enum de tipo de item de orçamento
AnexoBaixaResponseDTO
object
7 properties
ProductListChildResponse
object
18 properties
TipoDeSituacaoOrcamento
string
Enum de tipo de situação de orçamento
ItemNotificacaoCobranca
object
6 properties
CategoriaFinanceira
object
4 properties
TipoNegociacao
string
ItemVariacaoRequest
object
7 properties 4 required
CriarDescontoOrcamento
object
Modelo de criação de desconto aplicado ao orçamento
2 properties
AnexoParcela
object
9 properties
ComposicaoValorResumo
object
Resumo da composição de valores do contrato
5 properties
TipoDesconto
string
EventoFinanceiroRequest
object
8 properties 7 required
ListagemContratoResponse
object
2 properties
CentroCustoParcela
object
Estrutura resumida de centro de custo enviada em itens de parcela
2 properties
Contrato
object
6 properties
GerarCobrancaRequestDto
object
7 properties 5 required
Rateio
object
5 properties
GerarCobrancaRequestAtributosDto
object
1 property
BaixaResponseDTO
object
17 properties
ComposicaoValor
object
6 properties 1 required
ContaFinanceiraDetalhes
object
Detalhes de uma conta financeira
3 properties
TransferenciaContaFinanceiraResponse
object
Resposta paginada contendo a lista de transferências entre contas financeiras
2 properties
ItensPaginados
object
3 properties
Parcela
object
30 properties
RateioCentroCusto
object
3 properties
Referencia
object
3 properties
Categoria
object
7 properties
Dimensao
object
3 properties
Renegociacao
object
Informações de renegociação.
2 properties
ResumoCriacaoOrcamento
object
Modelo de resposta da criação de orçamento
1 property
ListagemOrcamentosPorFiltro
object
Listagem de orçamentos com filtros
2 properties
BaixaAtualizacaoRequestDTO
object
7 properties 1 required
RenegociacaoContaAReceber
object
Informações de renegociação.
3 properties
CondicaoPagamentoRequest
object
5 properties 2 required
ParcelaAtualizacaoResponse
object
11 properties
ExclusaoLote
object
1 property 1 required
CentroDeCusto
object
4 properties
ParcelaContaFinanceira
object
7 properties
CategoriaRateio
object
3 properties 2 required
TipoPendenciaResponse
object
2 properties
TipoVariacao
object
3 properties
Venda
object
16 properties
ItemVariacao
object
8 properties
TransferenciaContaFinanceira
object
Representa uma transferência entre contas financeiras da empresa
6 properties
TipoDeExpiracao
string
Enum de tipo de expiração
VendaEditadaResponse
object
2 properties
Item_2
object
8 properties
ContratoToCreateResponse
object
3 properties
ListagemContratoItemResponse
object
6 properties
EstoqueCriacaoProduto
object
5 properties
CategoriaParcela
object
Estrutura resumida de categoria enviada em itens de parcela
2 properties
SituacaoNegociacao
object
3 properties
ItemVendaRequest
object
6 properties 3 required
CriarComposicaoValorOrcamento
object
Modelo de criação da composição de valor do orçamento, incluindo frete e desconto
2 properties
VariacaoResponse
object
2 properties
ConfiguracaoRecorrenciaResumo
object
Resumo da configuração de recorrência do contrato
2 properties
ProductListResponse
object
18 properties
ClienteContratoResponse
object
2 properties
CondicaoPagamento
object
4 properties 2 required
LocalPrestacaoServicoResumo
object
Resumo do local de prestação de serviço do contrato
1 property
ProdutoDesativadoResponse
object
2 properties
TotaisVenda
object
Valores das de vendas com status Aprovado, Cancelado, Esperando aprovação e Total
4 properties
ExclusaoResponse
object
2 properties
TipoDeItens
string
Enum de tipo de itens
ClienteResumo
object
Resumo dos dados do cliente vinculado ao contrato
2 properties
TipoDeDesconto
string
Enum de tipo de desconto
ListagemDeProdutosPorFiltroResponse
object
2 properties
Situacao
object
2 properties
PagamentoCartao
object
3 properties
TipoPendente
object
2 properties
CondicaoPagamentoResponse
object
8 properties
Totais_2
object
3 properties
SugestaoPadrao
objectnull
Sugestão padrão de categoria para a operação. Quando sugestaopadrao=false, este campo é retornado como null.
2 properties
BandeiraCartao
string
Fatura
object
3 properties
StatusVisualizacaoMensagem
string
CriacaoCentroDeCustoRequest
object
2 properties 1 required
InstituicaoBancaria
object
Informações da instituição bancária
2 properties
Termo
object
7 properties 5 required
Negociacao
object
20 properties
TemplateNaturezaOperacao
string
SaldoInicialContaFinanceira
object
Informações sobre o saldo inicial de uma conta financeira, incluindo o valor e a data de competência
4 properties
TipoVariacaoRequest
object
2 properties 2 required
PerdaFinanceira
object
2 properties
NaturezaOperacao
object
6 properties
Status
string
Orcamento
object
Modelo que representa um orçamento
14 properties
ItemOrcamentoPorFiltro
object
12 properties
SolicitacaoCobranca
object
19 properties
PeriodoDeAgendamento
string
Enum de período de agendamento
ParcelaRequest
object
3 properties 2 required
Baixa
object
17 properties
DiscountMonolithTranslatedDTO
object
2 properties 2 required
VariacaoRequest
object
2 properties
ComposicaoValorTransferencia
object
Composição detalhada do valor de uma transação financeira
6 properties
TipoOperacao
string
CentroCustoRateio
object
2 properties
ErroAPI
object
Modelo de resposta para erros da API
1 property
VendaParaEdicaoRequest
object
12 properties 7 required
EstruturaDRE
object
1 property
ComposicaoValorOrcamento
object
Modelo que representa a composição de valor de um orçamento
2 properties
FormaPagamento
string
ProductVariationOptionResponse
object
2 properties
TermosResumo
object
Resumo dos termos do contrato
7 properties
ContaAPagar
object
14 properties
CondicaoPagamentoResumo
object
Resumo das condições de pagamento do contrato
4 properties
ProtocolResponseDTO
object
3 properties
ListaCondicaoPagamento
object
1 property 1 required
SituacaoResponse
object
2 properties
ValorComposicao
object
6 properties
CentroDeCustoResponse
object
3 properties
ItemOrcamento
object
Modelo que representa um item de um orçamento
7 properties
GerarCobrancaRequestAtributosDescontoAntecipado
object
Deverá ser informado apenas um dos campos: valor ou percentual
3 properties
ProdutoResponse
object
14 properties
BaixaCriacaoResponseDTO
object
8 properties
ExclusaoLoteOrcamento
object
Modelo de lista de ids para exclusão de orçamentos em lote
1 property 1 required
ParcelaNegociacao
object
5 properties
Vendedor
object
3 properties
ParcelaResponse
object
4 properties
Cliente
object
9 properties
CriarOrcamento
object
Modelo de criação de orçamento
10 properties 4 required
NotificacaoCobranca
object
12 properties
ListagemVendasResponse
object
4 properties
Quitacao
object
Informações de quitação de uma conta financeira incluindo data, composição de valores e detalhes da conta
3 properties
MudancaEstoque
string
CriarItemOrcamento
object
Modelo de criação de item do orçamento
4 properties 1 required
CriacaoVendaRequest
object
12 properties 6 required
ValorComposicaoDTO
object
5 properties 1 required
ContaFinanceira
object
10 properties
EventoFinanceiro
object
IDs dos eventos financeiros alterados
1 property
QuantidadesVenda
object
Quantidades de vendas com status Aprovado, Cancelado, Esperando aprovação e Total
4 properties
NegociadorContaAPagarOuReceber
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conta-azul-v1-api-openapi.yml Raw ↑

Other APIs Conta Azul publishes across the network.

Conta Azul API
Where this information came from

This is an independent, third-party profile of Conta Azul v1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.