{"items":[{"type":"link","label":"Financeiro","link":"/docs/financial-apis-openapi","routeSlug":"/docs/financial-apis-openapi"},{"type":"link","label":"Criar contas a pagar e a receber agora leva uma única chamada","link":"/docs/financial-apis-openapi/section/criar-contas-a-pagar-e-a-receber-agora-leva-uma-unica-chamada","routeSlug":"/docs/financial-apis-openapi/section/criar-contas-a-pagar-e-a-receber-agora-leva-uma-unica-chamada"},{"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/createreceivable","routeSlug":"/docs/financial-apis-openapi/v1/createreceivable","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, cliente, conta financeira, rateio e condições de pagamento. Facilita o registro de receitas previstas ou realizadas."}},"badges":[{"name":"Novo · use este","color":"#12B76A","position":"before"}],"httpPath":"/v1/financeiro/contas-a-receber"},{"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":"Retorno com protocolo descontinuado em 18/10/2026. A partir dessa data esta rota deixa de retornar 202 com protocolo e passa a responder igual ao POST /v1/financeiro/contas-a-receber: 201 com a conta criada, já com o id. A API de Protocolos (GET /v1/protocolo/{id}) deixa de existir."}},"badges":[{"name":"Protocolo descontinuado em 18/10/2026","color":"#D92D20","position":"before"}],"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/createpayable","routeSlug":"/docs/financial-apis-openapi/v1/createpayable","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, fornecedor, condições de pagamento, descrição, conta financeira e rateio. Esse endpoint facilita o registro das obrigações financeiras da empresa."}},"badges":[{"name":"Novo · use este","color":"#12B76A","position":"before"}],"httpPath":"/v1/financeiro/contas-a-pagar"},{"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":"Retorno com protocolo descontinuado em 18/10/2026. A partir dessa data esta rota deixa de retornar 202 com protocolo e passa a responder igual ao POST /v1/financeiro/contas-a-pagar: 201 com a conta criada, já com o id. A API de Protocolos (GET /v1/protocolo/{id}) deixa de existir."}},"badges":[{"name":"Protocolo descontinuado em 18/10/2026","color":"#D92D20","position":"before"}],"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"}]}]}