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.
The identity and technical contract details declared by the specification.
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
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
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
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
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
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
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Conta Azul publishes across the network.