{"items":[{"type":"group","label":"Visão Geral","items":[{"type":"link","fsPath":"introduction.md","metadata":{"type":"markdown"},"label":"Introdução","link":"/introduction","routeSlug":"/introduction"},{"type":"link","fsPath":"whatisapi.md","metadata":{"type":"markdown"},"label":"O que é API?","link":"/whatisapi","routeSlug":"/whatisapi"},{"type":"link","fsPath":"whoisitfor.md","metadata":{"type":"markdown"},"label":"Para quem é destinada a API da Conta Azul?","link":"/whoisitfor","routeSlug":"/whoisitfor"},{"type":"link","fsPath":"minimumrequirements.md","metadata":{"type":"markdown"},"label":"Requisitos mínimos","link":"/minimumrequirements","routeSlug":"/minimumrequirements"}]},{"type":"group","label":"Primeiros Passos","items":[{"type":"link","fsPath":"guide.md","metadata":{"type":"markdown"},"label":"Credenciais","link":"/guide","routeSlug":"/guide"},{"type":"group","label":"Autenticação OAuth 2.0","items":[{"type":"group","label":"Realizando o fluxo completo OAuth 2.0","items":[{"type":"link","fsPath":"auth.md","metadata":{"type":"markdown"},"label":"Visão geral","link":"/auth","routeSlug":"/auth"},{"type":"link","fsPath":"whydoweuse.md","metadata":{"type":"markdown"},"label":"Por que usamos OAuth 2.0?","link":"/whydoweuse","routeSlug":"/whydoweuse"},{"type":"link","fsPath":"requestingcode.md","metadata":{"type":"markdown"},"label":"Etapa 1 - Solicitando o código de autorização","link":"/requestingcode","routeSlug":"/requestingcode"},{"type":"link","fsPath":"changecode.md","metadata":{"type":"markdown"},"label":"Etapa 2 - Trocando o código pelo token","link":"/changecode","routeSlug":"/changecode"},{"type":"link","fsPath":"renewingaccesstoken.md","metadata":{"type":"markdown"},"label":"Etapa 3 - Renovando o token de acesso","link":"/renewingaccesstoken","routeSlug":"/renewingaccesstoken"},{"type":"link","fsPath":"makingcalls.md","metadata":{"type":"markdown"},"label":"Etapa 4 - Fazendo chamadas autenticadas","link":"/makingcalls","routeSlug":"/makingcalls"}]},{"type":"link","fsPath":"extension-guide.md","metadata":{"type":"markdown"},"label":"Guia da Extensão Conta Azul","link":"/extension-guide","routeSlug":"/extension-guide"},{"type":"link","fsPath":"authorize-multiple-clients.md","metadata":{"type":"markdown"},"label":"Múltiplos Clientes","link":"/authorize-multiple-clients","routeSlug":"/authorize-multiple-clients"}]}]},{"type":"group","fsPath":"usage-guide.md","metadata":{"type":"markdown"},"label":"Guias de uso","link":"/usage-guide","routeSlug":"/usage-guide","items":[{"type":"link","fsPath":"guide_installment_by_id.md","metadata":{"type":"markdown"},"label":"Rateio, centros de custo e categorias financeiras","link":"/get-parcela-por-id-rateio-categoria-centro-custo","routeSlug":"/get-parcela-por-id-rateio-categoria-centro-custo"}]},{"type":"group","fsPath":"aboutapis.md","metadata":{"type":"markdown"},"label":"API","link":"/aboutapis","routeSlug":"/aboutapis","items":[{"type":"group","label":"Contratos","items":[{"type":"link","label":"Contratos","link":"/docs/open-api-scheduled-sales","routeSlug":"/docs/open-api-scheduled-sales"},{"type":"group","label":"v1","link":"/docs/open-api-scheduled-sales/v1","routeSlug":"/docs/open-api-scheduled-sales/v1","items":[{"label":"Retornar os contratos por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/listarcontratos","routeSlug":"/docs/open-api-scheduled-sales/v1/listarcontratos","metadata":{"seo":{"title":"Retornar os contratos por filtro","description":"Permite consultar contratos existentes, com suporte a filtros que facilitam a busca e a gestão dos contratos criados (ex. por cliente, data, status, entre outros).Os parâmetros de múltiplos valores (ex.: cliente_id, tipo_pagamento) aceitam dois formatos equivalentes: chaves repetidas (?cliente_id=<uuid1>&cliente_id=<uuid2>) ou valores separados por vírgula (?cliente_id=<uuid1>,<uuid2>)."}},"httpPath":"/v1/contratos"},{"label":"Criar um novo contrato","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/criarcontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/criarcontrato","metadata":{"seo":{"title":"Criar um novo contrato","description":"Permite criar um novo contrato, definindo as informações necessárias para configuração da recorrência, como período, produtos/serviços vinculados e demais parâmetros do contrato."}},"httpPath":"/v1/contratos"},{"label":"Retornar o próximo número do contrato disponível","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/obterproximonumerocontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/obterproximonumerocontrato","metadata":{"seo":{"title":"Retornar o próximo número do contrato disponível","description":"Permite consultar o próximo número de contrato a ser utilizado no momento da criação."}},"httpPath":"/v1/contratos/proximo-numero"},{"label":"Retornar o contrato por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/obtercontratoporid","routeSlug":"/docs/open-api-scheduled-sales/v1/obtercontratoporid","metadata":{"seo":{"title":"Retornar o contrato por id","description":"Recupera os detalhes de um contrato específico por ID. Útil quando quiser exibir ou sincronizar todos os dados de um contrato específico."}},"httpPath":"/v1/contratos/{id}"},{"label":"Remover um contrato","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/removercontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/removercontrato","metadata":{"seo":{"title":"Remover um contrato","description":"Remove um contrato existente. O contrato será excluído permanentemente, cancelando todas as vendas associadas (agendadas e efetivadas). Contratos em reajuste de valor não podem ser removidos."}},"httpPath":"/v1/contratos/{id}"},{"label":"Encerrar um contrato","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/encerrarcontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/encerrarcontrato","metadata":{"seo":{"title":"Encerrar um contrato","description":"Encerra um contrato ativo. O contrato será desativado e não poderá mais gerar novas cobranças. Contratos que estão passando por reajuste de valor não podem ser encerrados."}},"httpPath":"/v1/contratos/{id}/encerrar"}]}]},{"type":"group","label":"Financeiro","items":[{"type":"group","label":"Financeiro","items":[{"type":"link","label":"Financeiro","link":"/docs/financial-apis-openapi","routeSlug":"/docs/financial-apis-openapi"},{"type":"group","label":"v1","link":"/docs/financial-apis-openapi/v1","routeSlug":"/docs/financial-apis-openapi/v1","items":[{"label":"Retornar os centros de custo por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchcostcenters","routeSlug":"/docs/financial-apis-openapi/v1/searchcostcenters","metadata":{"seo":{"title":"Retornar os centros de custo por filtro","description":"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."}},"httpPath":"/v1/centro-de-custo"},{"label":"Criar um novo centro de custo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/createcostcenter","routeSlug":"/docs/financial-apis-openapi/v1/createcostcenter","metadata":{"seo":{"title":"Criar um novo centro de custo","description":"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."}},"httpPath":"/v1/centro-de-custo"},{"label":"Retornar as parcelas pelo id do evento financeiro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getinstallmentsbyeventid","routeSlug":"/docs/financial-apis-openapi/v1/getinstallmentsbyeventid","metadata":{"seo":{"title":"Retornar as parcelas pelo id do evento financeiro","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/{id_evento}/parcelas"},{"label":"Retornar as categorias por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchcategories","routeSlug":"/docs/financial-apis-openapi/v1/searchcategories","metadata":{"seo":{"title":"Retornar as categorias por filtro","description":"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."}},"httpPath":"/v1/categorias"},{"label":"Retornar a configuração de de-para de categorias","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getdefaultcategoryconfig","routeSlug":"/docs/financial-apis-openapi/v1/getdefaultcategoryconfig","metadata":{"seo":{"title":"Retornar a configuração de de-para de categorias","description":"Retorna o de-para entre as operações financeiras e as categorias configuradas para o tenant, incluindo opcionalmente a sugestão padrão de categoria para cada operação."}},"httpPath":"/v1/categorias/configuracao-padrao"},{"label":"Retornar as categorias DRE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchdrecategories","routeSlug":"/docs/financial-apis-openapi/v1/searchdrecategories","metadata":{"seo":{"title":"Retornar as categorias DRE","description":"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."}},"httpPath":"/v1/financeiro/categorias-dre"},{"label":"Retornar as contas financeiras por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchfinancialaccounts","routeSlug":"/docs/financial-apis-openapi/v1/searchfinancialaccounts","metadata":{"seo":{"title":"Retornar as contas financeiras por filtro","description":"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."}},"httpPath":"/v1/conta-financeira"},{"label":"Retornar o saldo atual pelo id da conta financeira","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchbalancebyfinancialaccountid","routeSlug":"/docs/financial-apis-openapi/v1/searchbalancebyfinancialaccountid","metadata":{"seo":{"title":"Retornar o saldo atual pelo id da conta financeira","description":"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."}},"httpPath":"/v1/conta-financeira/{id_conta_financeira}/saldo-atual"},{"label":"Retornar as transferências entre contas financeiras por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchaccountingexporttransfers","routeSlug":"/docs/financial-apis-openapi/v1/searchaccountingexporttransfers","metadata":{"seo":{"title":"Retornar as transferências entre contas financeiras por filtro","description":"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."}},"httpPath":"/v1/financeiro/transferencias"},{"label":"Criar um novo evento financeiro de contas a receber","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/createreceivablefinancialevent","routeSlug":"/docs/financial-apis-openapi/v1/createreceivablefinancialevent","metadata":{"seo":{"title":"Criar um novo evento financeiro de contas a receber","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber"},{"label":"Retornar as receitas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchinstallmentstoreceivebyfilter","routeSlug":"/docs/financial-apis-openapi/v1/searchinstallmentstoreceivebyfilter","metadata":{"seo":{"title":"Retornar as receitas por filtro","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/buscar"},{"label":"Criar um novo evento financeiro de contas a pagar","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/createpayablefinancialevent","routeSlug":"/docs/financial-apis-openapi/v1/createpayablefinancialevent","metadata":{"seo":{"title":"Criar um novo evento financeiro de contas a pagar","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-pagar"},{"label":"Retornar as despesas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchinstallmentstopaybyfilter","routeSlug":"/docs/financial-apis-openapi/v1/searchinstallmentstopaybyfilter","metadata":{"seo":{"title":"Retornar as despesas por filtro","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar"},{"label":"Retornar a parcela por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getinstallmentbyid","routeSlug":"/docs/financial-apis-openapi/v1/getinstallmentbyid","metadata":{"seo":{"title":"Retornar a parcela por id","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{id}"},{"label":"Atualizar parcialmente uma parcela por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/updateinstallment","routeSlug":"/docs/financial-apis-openapi/v1/updateinstallment","metadata":{"seo":{"title":"Atualizar parcialmente uma parcela por id","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{id}"},{"label":"Retornar os IDs dos eventos financeiros alterados em um período","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getalteredfinancialevents","routeSlug":"/docs/financial-apis-openapi/v1/getalteredfinancialevents","metadata":{"seo":{"title":"Retornar os IDs dos eventos financeiros alterados em um período","description":"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."}},"httpPath":"/v1/financeiro/eventos-financeiros/alteracoes"},{"label":"Retornar os saldos iniciais das contas financeiras","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getinitialbalancesoffinancialaccounts","routeSlug":"/docs/financial-apis-openapi/v1/getinitialbalancesoffinancialaccounts","metadata":{"seo":{"title":"Retornar os saldos iniciais das contas financeiras","description":"Permite consultar os saldos iniciais das contas financeiras em um período definido por data de início e fim."}},"httpPath":"/v1/financeiro/eventos-financeiros/saldo-inicial"}]}]},{"type":"group","label":"Baixas","items":[{"type":"link","label":"Baixas","link":"/docs/acquittance-apis-openapi","routeSlug":"/docs/acquittance-apis-openapi"},{"type":"group","label":"v1","link":"/docs/acquittance-apis-openapi/v1","routeSlug":"/docs/acquittance-apis-openapi/v1","items":[{"label":"Criar uma nova baixa","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/criarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/criarbaixa","metadata":{"seo":{"title":"Criar uma nova baixa","description":"Permite registrar uma nova baixa vinculada a uma parcela específica. Por meio desse endpoint, é possível informar os dados do pagamento, como data, valor, juros, multa, descontos e método de pagamento. Ao registrar a baixa, o sistema atualiza automaticamente o status da parcela refletindo a quitação realizada."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa"},{"label":"Retornar as baixas pelo id da parcela","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/listarbaixas","routeSlug":"/docs/acquittance-apis-openapi/v1/listarbaixas","metadata":{"seo":{"title":"Retornar as baixas pelo id da parcela","description":"Permite consultar todas as baixas associadas a uma determinada parcela. Essa funcionalidade possibilita o acompanhamento detalhado de pagamentos realizados, facilitando a auditoria e o controle financeiro."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa"},{"label":"Atualizar parcialmente uma baixa por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/atualizarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/atualizarbaixa","metadata":{"seo":{"title":"Atualizar parcialmente uma baixa por id","description":"Permite atualizar parcialmente as informações de uma baixa. Use a baixa parcial quando houver pagamento ou recebimento parcial de uma fatura, seja por negociação com cliente/fornecedor ou em situações de inadimplência parcial. Por meio desse endpoint, é possível corrigir dados como valor, conta financeira, data de pagamento ou observações, mantendo o controle de versão para evitar conflitos de atualização."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}"},{"label":"Deletar baixa por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/deletarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/deletarbaixa","metadata":{"seo":{"title":"Deletar baixa por id","description":"Permite excluir uma baixa existente do sistema. Esse endpoint deve ser utilizado com cautela, pois a exclusão impacta diretamente o saldo e o histórico financeiro da parcela associada."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}"},{"label":"Retornar a baixa por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/buscarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/buscarbaixa","metadata":{"seo":{"title":"Retornar a baixa por id","description":"Permite consultar os detalhes de uma baixa específica a partir do seu identificador único (baixa_id). O retorno inclui informações completas sobre a baixa, como data de pagamento, valores envolvidos, conta financeira utilizada, método de pagamento e observações registradas."}},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}"}]}]},{"type":"group","label":"Cobranças","items":[{"type":"link","label":"Cobranças","link":"/docs/charge-apis-openapi","routeSlug":"/docs/charge-apis-openapi"},{"type":"group","label":"v1","link":"/docs/charge-apis-openapi/v1","routeSlug":"/docs/charge-apis-openapi/v1","items":[{"label":"Retornar a cobrança por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/charge-apis-openapi/v1/buscarcobrancaporid","routeSlug":"/docs/charge-apis-openapi/v1/buscarcobrancaporid","metadata":{"seo":{"title":"Retornar a cobrança por id","description":"Permite consultar os detalhes de uma cobrança específica utilizando seu identificador único (id_cobranca)."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}"},{"label":"Deletar cobrança por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/charge-apis-openapi/v1/deletarcobrancaporid","routeSlug":"/docs/charge-apis-openapi/v1/deletarcobrancaporid","metadata":{"seo":{"title":"Deletar cobrança por id","description":"Permite cancelar uma cobrança existente identificada por id_cobranca. É recomendada apenas quando a cobrança foi gerada incorretamente ou precisa ser invalidada antes de seu pagamento."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}"},{"label":"Criar uma nova cobrança","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/charge-apis-openapi/v1/criarcobranca","routeSlug":"/docs/charge-apis-openapi/v1/criarcobranca","metadata":{"seo":{"title":"Criar uma nova cobrança","description":"Permite criar uma nova cobrança, por meio desse endpoint, é possível informar o valor, data de vencimento, descrição da fatura e demais parâmetros que definem a cobrança. Essa funcionalidade facilita a geração automatizada de cobranças."}},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca"}]}]}]},{"type":"group","label":"Pessoas","items":[{"type":"link","label":"Pessoas","link":"/open-api-docs/open-api-person","routeSlug":"/open-api-docs/open-api-person"},{"type":"group","label":"v1","link":"/open-api-docs/open-api-person/v1","routeSlug":"/open-api-docs/open-api-person/v1","items":[{"label":"Retornar as pessoas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornapessoasporfiltros","routeSlug":"/open-api-docs/open-api-person/v1/retornapessoasporfiltros","metadata":{"seo":{"title":"Retornar as pessoas por filtro","description":"Permite consultar as pessoas cadastradas, com suporte a filtros como página, tamanho, ordenação, busca por nome, documento, email, tipo de perfil, entre outros. Essa funcionalidade facilita a listagem, o monitoramento de pessoas no sistema."}},"httpPath":"/v1/pessoas"},{"label":"Criar uma nova pessoa","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/criarpessoa","routeSlug":"/open-api-docs/open-api-person/v1/criarpessoa","metadata":{"seo":{"title":"Criar uma nova pessoa","description":"Permite criar uma nova pessoa, informando dados como nome, tipo de pessoa (Física, Jurídica ou Estrangeira), documentos (CPF, CNPJ), email, perfis associados, endereços e outros parâmetros. Esse endpoint viabiliza a automação de cadastro de clientes, fornecedores e transportadoras."}},"httpPath":"/v1/pessoas"},{"label":"Ativar pessoas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/ativarpessoasemlote","routeSlug":"/open-api-docs/open-api-person/v1/ativarpessoasemlote","metadata":{"seo":{"title":"Ativar pessoas em lote","description":"Permite ativar em lote um conjunto de pessoas previamente inativadas ou que estejam com status desativado. Essa funcionalidade é útil para reativar perfis inativos de forma massiva."}},"httpPath":"/v1/pessoas/ativar"},{"label":"Retornar dados da empresa conectada","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornaempresadacontaconectada","routeSlug":"/open-api-docs/open-api-person/v1/retornaempresadacontaconectada","metadata":{"seo":{"title":"Retornar dados da empresa conectada","description":"Permite consultar as informações cadastrais e de contato da empresa vinculada ao token de autenticação utilizado na requisição. Use este endpoint para exibir ou validar os dados da empresa parceira conectada à sua integração, como razão social e CNPJ."}},"httpPath":"/v1/pessoas/conta-conectada"},{"label":"Excluir pessoas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/excluirpessoasemlote","routeSlug":"/open-api-docs/open-api-person/v1/excluirpessoasemlote","metadata":{"seo":{"title":"Excluir pessoas em lote","description":"Permite excluir pessoas em lote, a partir de seus identificadores."}},"httpPath":"/v1/pessoas/excluir"},{"label":"Desativar pessoas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/desativarpessoasemlote","routeSlug":"/open-api-docs/open-api-person/v1/desativarpessoasemlote","metadata":{"seo":{"title":"Desativar pessoas em lote","description":"Permite inativar em lote pessoas, alterando seu status para \"inativo\". Útil para automações de limpeza de cadastros ou para perfis que não precisam mais estar ativos."}},"httpPath":"/v1/pessoas/inativar"},{"label":"Retornar a pessoa por legacyid","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornapessoaporlegacyid","routeSlug":"/open-api-docs/open-api-person/v1/retornapessoaporlegacyid","metadata":{"seo":{"title":"Retornar a pessoa por legacyid","description":"Esse endpoint existe para garantir compatibilidade entre a API antiga (V1 legada) e a API nova de Pessoas. Quando você faz requisições na API nova, cada pessoa passa a ter um UUID, que é o novo identificador usado pelo ERP e pelas integrações atuais. Ao mesmo tempo, algumas aplicações antigas ainda usam o id_legado, que era o identificador utilizado na API V1. Importante saber - Relação entre os IDs: uuid → ID novo da pessoa (padrão atual), id_legado → ID antigo, usado na primeira versão da API."}},"httpPath":"/v1/pessoas/legado/{id}"},{"label":"Retornar a pessoa por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/retornapessoaporid","routeSlug":"/open-api-docs/open-api-person/v1/retornapessoaporid","metadata":{"seo":{"title":"Retornar a pessoa por id","description":"Permite consultar os detalhes de uma pessoa específica pelo seu identificador (id). A resposta inclui campos completos como nome, tipo de pessoa, documentos, perfis, contatos, endereços e demais informações pertinentes ao cadastro."}},"httpPath":"/v1/pessoas/{id}"},{"label":"Atualizar uma pessoa por id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/atualizarpessoaporid","routeSlug":"/open-api-docs/open-api-person/v1/atualizarpessoaporid","metadata":{"seo":{"title":"Atualizar uma pessoa por id","description":"Permite substituir ou atualizar integralmente o cadastro de uma pessoa existente identificada por id. Indicada quando há necessidade de modificar vários campos de uma vez."}},"httpPath":"/v1/pessoas/{id}"},{"label":"Atualizar parcialmente uma pessoa por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-person/v1/atualizarparcialmentepessoa","routeSlug":"/open-api-docs/open-api-person/v1/atualizarparcialmentepessoa","metadata":{"seo":{"title":"Atualizar parcialmente uma pessoa por id","description":"Permite atualizar parcialmente o cadastro de uma pessoa existente (por exemplo: alterar email, telefone, tipo de perfil ou endereço) identificada por id. Essa abordagem garante menor impacto e maior controle na atualização dos dados."}},"httpPath":"/v1/pessoas/{id}"}]}]},{"type":"group","label":"Produtos","items":[{"type":"link","label":"Produtos","link":"/open-api-docs/open-api-inventory","routeSlug":"/open-api-docs/open-api-inventory"},{"type":"group","label":"v1","link":"/open-api-docs/open-api-inventory/v1","routeSlug":"/open-api-docs/open-api-inventory/v1","items":[{"label":"Retornar os produtos por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarlistagemdeprodutos","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarlistagemdeprodutos","metadata":{"seo":{"title":"Retornar os produtos por filtro","description":"Permite listar os produtos cadastrados, com suporte a filtros como página, tamanho, busca por nome, sku ou ean, status (\"ativo\", \"inativo\") e ordenação."}},"httpPath":"/v1/produtos"},{"label":"Criar um novo produto","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/criarproduto","routeSlug":"/open-api-docs/open-api-inventory/v1/criarproduto","metadata":{"seo":{"title":"Criar um novo produto","description":"Permite criar um novo produto, informando dados como nome, código interno, unidade de medida, categoria, preço, estoque inicial, entre outros parâmetros. Ideal para automatizar o cadastro de itens novos no sistema."}},"httpPath":"/v1/produtos"},{"label":"Retornar as categorias por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarcategoriasdeprodutos","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarcategoriasdeprodutos","metadata":{"seo":{"title":"Retornar as categorias por filtro","description":"Permite listar categorias de produtos cadastradas na Conta Azul, com paginação e filtro por texto. Útil para validar categoria na criação de produtos."}},"httpPath":"/v1/produtos/categorias"},{"label":"Retornar os cests por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarcests","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarcests","metadata":{"seo":{"title":"Retornar os cests por filtro","description":"Retorna códigos CEST (Código Especificador da Substituição Tributária) usados para questões fiscais, com filtro por texto e paginação. Importante para definir a tributação correta de produtos no ERP."}},"httpPath":"/v1/produtos/cest"},{"label":"Retornar as categorias de e-commerce por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarcategoriasdeecommercedeprodutos","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarcategoriasdeecommercedeprodutos","metadata":{"seo":{"title":"Retornar as categorias de e-commerce por filtro","description":"Retorna categorias específicas para e-commerce (não necessariamente as mesmas categorias internas), permite filtro por descrição. Útil para integrar categorização de produtos entre seu sistema e Conta Azul."}},"httpPath":"/v1/produtos/ecommerce-categorias"},{"label":"Retornar as marcas de ecommerce por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarmarcasecommerce","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarmarcasecommerce","metadata":{"seo":{"title":"Retornar as marcas de ecommerce por filtro","description":"Busca marcas usadas no contexto de e-commerce, com paginação, ordenação e filtro por nome. Permite sincronizar marcas entre sistema de vendas online e Conta Azul."}},"httpPath":"/v1/produtos/ecommerce-marcas"},{"label":"Retornar os ncms por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarncms","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarncms","metadata":{"seo":{"title":"Retornar os ncms por filtro","description":"Retorna códigos NCM (Nomenclatura Comum do Mercosul), com filtro por texto e paginação. Necessário para classificação fiscal de produtos."}},"httpPath":"/v1/produtos/ncm"},{"label":"Retornar as unidades de medida por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarunidadesdemedida","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarunidadesdemedida","metadata":{"seo":{"title":"Retornar as unidades de medida por filtro","description":"Retorna as unidades de medida possíveis para produtos, com paginação e busca por descrição. Essencial para definir medidas fiscais (peso, volume, etc.) ou unidades de estoque."}},"httpPath":"/v1/produtos/unidades-medida"},{"label":"Retornar o produto por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/retornarprodutoporid","routeSlug":"/open-api-docs/open-api-inventory/v1/retornarprodutoporid","metadata":{"seo":{"title":"Retornar o produto por id","description":"Traz todos os detalhes de um produto específico (estoque, fiscal, e-commerce, variações, pesos, unidades, etc.). Ideal para consultar dados completos antes de exibir para usuário ou para sincronização."}},"httpPath":"/v1/produtos/{id}"},{"label":"Deletar produto por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/deletarprodutoporid","routeSlug":"/open-api-docs/open-api-inventory/v1/deletarprodutoporid","metadata":{"seo":{"title":"Deletar produto por id","description":"Remove o produto correspondente ao Id. Use para excluir produtos que não são mais necessários ou foram removidos do catálogo."}},"httpPath":"/v1/produtos/{id}"},{"label":"Atualizar parcialmente um produto por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-inventory/v1/atualizarprodutoparcialmente","routeSlug":"/open-api-docs/open-api-inventory/v1/atualizarprodutoparcialmente","metadata":{"seo":{"title":"Atualizar parcialmente um produto por id","description":"Permite atualizar apenas alguns campos de um produto (nome, EAN, SKU, NCM, peso, valor de venda, unidade de medida, etc.). É útil para ajustes pontuais sem precisar reenviar o objeto completo do produto."}},"httpPath":"/v1/produtos/{id}"}]}]},{"type":"group","label":"Protocolos","items":[{"type":"link","label":"Protocolos","link":"/docs/protocol-apis-openapi","routeSlug":"/docs/protocol-apis-openapi"},{"type":"group","label":"v1","link":"/docs/protocol-apis-openapi/v1","routeSlug":"/docs/protocol-apis-openapi/v1","items":[{"label":"Retornar o protocolo por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/protocol-apis-openapi/v1/buscarprotocoloporid","routeSlug":"/docs/protocol-apis-openapi/v1/buscarprotocoloporid","metadata":{"seo":{"title":"Retornar o protocolo por id","description":"Permite consultar os detalhes de um protocolo específico identificado por id."}},"httpPath":"/v1/protocolo/{id}"}]}]},{"type":"group","label":"Notas fiscais","items":[{"type":"link","label":"Notas fiscais","link":"/open-api-docs/open-api-invoice","routeSlug":"/open-api-docs/open-api-invoice"},{"type":"group","label":"v1","link":"/open-api-docs/open-api-invoice/v1","routeSlug":"/open-api-docs/open-api-invoice/v1","items":[{"label":"Retornar as notas fiscais por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisporfiltro","routeSlug":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisporfiltro","metadata":{"seo":{"title":"Retornar as notas fiscais por filtro","description":"Permite consultar todas as notas fiscais de produto (NFe) já emitidas no ERP, com suporte a filtros como data, número da nota, id da venda.. Este endpoint retorna somente NFe com status EMITIDA e CORRIGIDA COM SUCESSO (outros status em construção). Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade."}},"httpPath":"/v1/notas-fiscais"},{"label":"Retornar notas fiscais de serviço por filtros","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisservicoporfiltro","routeSlug":"/open-api-docs/open-api-invoice/v1/obternotasfiscaisservicoporfiltro","metadata":{"seo":{"title":"Retornar notas fiscais de serviço por filtros","description":"Permite consultar todas as notas fiscais de serviço (NFS-e) já emitidas no ERP, com uso de filtros como data, número da nota, id da venda.. Este endpoint retorna NFS-e com todos os status possíveis a partir da emissão. Essa funcionalidade facilita o monitoramento fiscal, exportação para relatórios ou integração com contabilidade."}},"httpPath":"/v1/notas-fiscais-servico"},{"label":"Vincular nota fiscal a mdfe","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/vincularnotafiscalmdfe","routeSlug":"/open-api-docs/open-api-invoice/v1/vincularnotafiscalmdfe","metadata":{"seo":{"title":"Vincular nota fiscal a mdfe","description":"Permite associar uma ou mais notas fiscais (identificadas pelas chaves de acesso) a um MDF-e (Manifesto Eletrônico de Documento Fiscal). É possível também informar o status do vínculo (ex: \"AUTORIZADO\", \"ENCERRADO\", \"CANCELADO\"). Apoio no controle logístico e fiscal."}},"httpPath":"/v1/notas-fiscais/vinculo-mdfe"},{"label":"Retornar a nota fiscal por chave","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-invoice/v1/obternotafiscalporchave","routeSlug":"/open-api-docs/open-api-invoice/v1/obternotafiscalporchave","metadata":{"seo":{"title":"Retornar a nota fiscal por chave","description":"Permite consultar dados de uma nota fiscal específica, buscando pela sua chave de acesso."}},"httpPath":"/v1/notas-fiscais/{chave}"}]}]},{"type":"group","label":"Serviços","items":[{"type":"link","label":"Serviços","link":"/open-api-docs/open-api-service","routeSlug":"/open-api-docs/open-api-service"},{"type":"group","label":"v1","link":"/open-api-docs/open-api-service/v1","routeSlug":"/open-api-docs/open-api-service/v1","items":[{"label":"Retornar os serviços por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-service/v1/obterservicosporfiltro","routeSlug":"/open-api-docs/open-api-service/v1/obterservicosporfiltro","metadata":{"seo":{"title":"Retornar os serviços por filtro","description":"Permite listar os serviços cadastrados, com suporte a filtros como página, tamanho de página, busca por nome ou código. Ideal para sincronização de catálogo de serviços."}},"httpPath":"/v1/servicos"},{"label":"Criar um novo serviço","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-service/v1/criarservico","routeSlug":"/open-api-docs/open-api-service/v1/criarservico","metadata":{"seo":{"title":"Criar um novo serviço","description":"Permite criar um novo serviço, informando dados como código interno, descrição, tipo de serviço, preço, status (ativo/inativo), entre outros. Ideal para cadastro automatizado de serviços em sistemas externos."}},"httpPath":"/v1/servicos"},{"label":"Deletar serviços em lote","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-service/v1/deletarservicosemlote","routeSlug":"/open-api-docs/open-api-service/v1/deletarservicosemlote","metadata":{"seo":{"title":"Deletar serviços em lote","description":"Permite remover um serviço existente pelo seu identificador. Essa ação deve ser usada com cautela, pois pode impactar vendas ou contratos em uso."}},"httpPath":"/v1/servicos"},{"label":"Retornar o serviço por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-service/v1/obterservicoporid","routeSlug":"/open-api-docs/open-api-service/v1/obterservicoporid","metadata":{"seo":{"title":"Retornar o serviço por id","description":"Permite consultar os detalhes de um serviço específico pelo seu identificador (id). A resposta inclui campos como nome, código, descrição, preço, status, parâmetros de serviço, entre outros."}},"httpPath":"/v1/servicos/{id}"},{"label":"Atualizar parcialmente um serviço por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-service/v1/atualizarservicoparcialmente","routeSlug":"/open-api-docs/open-api-service/v1/atualizarservicoparcialmente","metadata":{"seo":{"title":"Atualizar parcialmente um serviço por id","description":"Permite atualizar parcialmente um serviço existente, como alterar o preço, descrição, status, ou outras propriedades que mudaram. Permite ajustes rápidos sem necessidade de substituir o objeto completo."}},"httpPath":"/v1/servicos/{id}"}]}]},{"type":"group","label":"Vendas","items":[{"type":"link","label":"Vendas","link":"/docs/sales-apis-openapi","routeSlug":"/docs/sales-apis-openapi"},{"type":"group","label":"v1","link":"/docs/sales-apis-openapi/v1","routeSlug":"/docs/sales-apis-openapi/v1","items":[{"label":"Retornar os vendedores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/listvendedores","routeSlug":"/docs/sales-apis-openapi/v1/listvendedores","metadata":{"seo":{"title":"Retornar os vendedores","description":"Retorna a lista de vendedores cadastrados na Conta Azul. Útil quando você precisa atribuir um vendedor a uma venda ou exibir opções de vendedores em sua interface."}},"httpPath":"/v1/venda/vendedores"},{"label":"Retornar a venda por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/getvendabyid","routeSlug":"/docs/sales-apis-openapi/v1/getvendabyid","metadata":{"seo":{"title":"Retornar a venda por id","description":"Recupera os detalhes de uma venda específica por ID (pode ser UUID ou id legado). Útil quando quiser exibir ou sincronizar todos os dados de uma venda específica."}},"httpPath":"/v1/venda/{id}"},{"label":"Atualizar uma venda por id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/editsale","routeSlug":"/docs/sales-apis-openapi/v1/editsale","metadata":{"seo":{"title":"Atualizar uma venda por id","description":"Permite atualizar uma venda existente. Útil se sua aplicação permite editar vendas depois que foram criadas no ERP."}},"httpPath":"/v1/venda/{id}"},{"label":"Retornar as vendas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/searchvendas","routeSlug":"/docs/sales-apis-openapi/v1/searchvendas","metadata":{"seo":{"title":"Retornar as vendas por filtro","description":"Retorna as vendas filtradas, podendo fazer uso de parâmetros de consulta como data inicial/final, cliente, situação, tipos de venda, IDs de produtos, IDs de categorias, paginação, entre outros. Use esse endpoint para construir telas de listagem, dashboards ou relatórios de vendas."}},"httpPath":"/v1/venda/busca"},{"label":"Criar uma nova venda","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/createvenda","routeSlug":"/docs/sales-apis-openapi/v1/createvenda","metadata":{"seo":{"title":"Criar uma nova venda","description":"Cria uma nova venda no sistema da Conta Azul. Ideal para registrar vendas vindas de sistemas externos diretamente no ERP da Conta Azul."}},"httpPath":"/v1/venda"},{"label":"Retornar o PDF de uma venda","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/printvendapdf","routeSlug":"/docs/sales-apis-openapi/v1/printvendapdf","metadata":{"seo":{"title":"Retornar o PDF de uma venda","description":"Gera e retorna um PDF da venda identificada pelo ID. Use quando precisar mostrar ao usuário ou armazenar uma versão impressa da venda."}},"httpPath":"/v1/venda/{id}/imprimir"},{"label":"Excluir vendas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/deletevendasbatch","routeSlug":"/docs/sales-apis-openapi/v1/deletevendasbatch","metadata":{"seo":{"title":"Excluir vendas em lote","description":"Permite excluir várias vendas de uma vez. Útil para excluir em lote vendas de forma automatizada. Útil durante sincronizações ou processos de limpeza de dados."}},"httpPath":"/v1/venda/exclusao-lote"},{"label":"Retornar os itens de uma venda pelo id da venda","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/getvendaitens","routeSlug":"/docs/sales-apis-openapi/v1/getvendaitens","metadata":{"seo":{"title":"Retornar os itens de uma venda pelo id da venda","description":"Retorna a lista de itens de uma venda, dado o ID da venda. Use para exibir um detalhe da venda (todos produtos/serviços) ou para sincronizar os itens da venda para outros sistemas."}},"httpPath":"/v1/venda/{id_venda}/itens"},{"label":"Retornar o próximo número de venda disponível","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/getnextvendanumber","routeSlug":"/docs/sales-apis-openapi/v1/getnextvendanumber","metadata":{"seo":{"title":"Retornar o próximo número de venda disponível","description":"Retorna o próximo número de venda disponível, segundo a numeração usada no ERP da Conta Azul. Pode ser usado antes de criar uma venda para garantir que você está usando uma sequência de número válida/nova."}},"httpPath":"/v1/venda/proximo-numero"}]}]},{"type":"group","label":"Orçamentos","items":[{"type":"link","label":"Orçamentos","link":"/docs/open-api-proposal","routeSlug":"/docs/open-api-proposal"},{"type":"group","label":"v1","link":"/docs/open-api-proposal/v1","routeSlug":"/docs/open-api-proposal/v1","items":[{"label":"Retornar orçamentos por filtros","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-proposal/v1/listarorcamentosporfiltros","routeSlug":"/docs/open-api-proposal/v1/listarorcamentosporfiltros","metadata":{"seo":{"title":"Retornar orçamentos por filtros","description":"Recupera a lista de orçamentos com base nos filtros informados."}},"httpPath":"/v1/orcamentos"},{"label":"Criar um orçamento","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-proposal/v1/criarorcamento","routeSlug":"/docs/open-api-proposal/v1/criarorcamento","metadata":{"seo":{"title":"Criar um orçamento","description":"Cria um novo orçamento no sistema da Conta Azul."}},"httpPath":"/v1/orcamentos"},{"label":"Excluir orçamentos em lote","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-proposal/v1/excluirorcamentosemlote","routeSlug":"/docs/open-api-proposal/v1/excluirorcamentosemlote","metadata":{"seo":{"title":"Excluir orçamentos em lote","description":"Permite excluir vários orçamentos de uma vez. Útil durante sincronizações ou processos de limpeza de dados."}},"httpPath":"/v1/orcamentos"},{"label":"Retornar o orçamento por ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-proposal/v1/obterorcamentoporid","routeSlug":"/docs/open-api-proposal/v1/obterorcamentoporid","metadata":{"seo":{"title":"Retornar o orçamento por ID","description":"Recupera os detalhes de um orçamento específico por ID. Útil quando quiser exibir ou sincronizar todos os dados de um orçamento específico."}},"httpPath":"/v1/orcamentos/{id}"}]}]},{"type":"group","label":"Captura","items":[{"type":"link","label":"Captura","link":"/open-api-docs/developer-platform-open-api-capture","routeSlug":"/open-api-docs/developer-platform-open-api-capture"},{"type":"group","label":"v1","link":"/open-api-docs/developer-platform-open-api-capture/v1","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1","items":[{"label":"Envia um documento para a captura e extração de dados","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/uploadarquivoscapturadocumentos","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/uploadarquivoscapturadocumentos","metadata":{"seo":{"title":"Envia um documento para a captura e extração de dados","description":"Recebe um arquivo (PDF, JPEG, PNG ou BMP; máximo de 10 MB) via multipart/form-data e o encaminha para a extração automática de dados. Retorna o identificador do documento a ser processado, utilizado para consultar o status do processamento posteriormente."}},"httpPath":"/v1/captura/documentos"},{"label":"Consulta o status de documentos e das extrações (Captura)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/consultastatusdocumentoscaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/consultastatusdocumentoscaptura","metadata":{"seo":{"title":"Consulta o status de documentos e das extrações (Captura)","description":"Consulta, para um ou mais documentos enviados à IA Captura, o status do processamento do documento e o status da captura (extração) gerada a partir dele. Um documento pode ser processado sem gerar captura — nesse caso, os campos da captura retornam vazios. Como o processamento é assíncrono, a orientação é consultar periodicamente (polling) até que os status cheguem a um estado final."}},"httpPath":"/v1/captura/documentos/status"},{"label":"Consulta os dados extraídos da captura do documento enviado","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/consultadadosextraidoscaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/consultadadosextraidoscaptura","metadata":{"seo":{"title":"Consulta os dados extraídos da captura do documento enviado","description":"Retorna os dados que a IA Captura extraiu do documento e a sugestão de evento financeiro associada. O envio do documento em POST /v1/captura/documentos devolve o id do documento; com ele, a consulta em GET /v1/captura/documentos/status devolve o id_captura; e é esse id_captura que identifica a captura consultada aqui. A prévia do evento financeiro (previa_evento_financeiro) e a sugestão (sugestao_evento_financeiro) são retornadas apenas quando o status da captura é PENDENTE; nos demais estados (PROCESSANDO, ACEITA, REJEITADA, FALHA) a resposta traz somente id, id_documento e status. Recomenda-se, portanto, consultar este endpoint quando o status já indicar que os dados de extração estão disponíveis (PENDENTE)."}},"httpPath":"/v1/captura/{id}"},{"label":"Aceita a prévia do evento financeiro da captura","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/aceitarpreviacaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/aceitarpreviacaptura","metadata":{"seo":{"title":"Aceita a prévia do evento financeiro da captura","description":"Confirma a prévia sugerida pela IA Captura e cria o evento financeiro correspondente na Conta Azul. A requisição não possui corpo — o aceite usa apenas o id_captura da rota, obtido na consulta de status. Retorna os dados do evento financeiro criado."}},"httpPath":"/v1/captura/{id}"},{"label":"Recusa a captura (rejeita o evento financeiro sugerido)","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/developer-platform-open-api-capture/v1/recusacaptura","routeSlug":"/open-api-docs/developer-platform-open-api-capture/v1/recusacaptura","metadata":{"seo":{"title":"Recusa a captura (rejeita o evento financeiro sugerido)","description":"Recusa a prévia do evento financeiro sugerido pela IA Captura para a captura informada, identificada pelo id_captura obtido em GET /v1/captura/documentos/status. Uma captura que já foi aceita ou que ainda está em processamento não pode ser recusada. Após a recusa, a captura deixa de ser retornada na consulta de status; se todas as capturas do documento forem recusadas, o próprio documento também deixa de ser listado."}},"httpPath":"/v1/captura/{id}"}]}]}]},{"type":"group","fsPath":"commonmistakes.md","metadata":{"type":"markdown"},"label":"Erros Comuns","link":"/commonmistakes","routeSlug":"/commonmistakes"},{"type":"group","fsPath":"faq.md","metadata":{"type":"markdown"},"label":"FAQ - Perguntas frequentes","link":"/faq","routeSlug":"/faq"},{"type":"group","fsPath":"playbook.md","metadata":{"type":"markdown"},"label":"Guia de Informações e Suporte","link":"/playbook","routeSlug":"/playbook"},{"type":"group","fsPath":"newsapi.md","metadata":{"type":"markdown"},"label":"Changelog da API","link":"/newsapi","routeSlug":"/newsapi","items":[{"type":"link","fsPath":"changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/changelog","routeSlug":"/changelog"}]}]}