# Documentação

- [bitERP Developer Docs](/docs): Documentação para desenvolvedores que integram com o bitERP via API REST ou MCP Server.
- Getting Started: undefined
  - [Introdução](/docs/getting-started): Visão geral do bitERP, ambientes disponíveis e como obter credenciais para integração.
  - [Quickstart](/docs/getting-started/quickstart): Faça sua primeira chamada à API do bitERP em menos de 5 minutos.
- API: undefined
  - [API de Integrações](/docs/api): Visão geral da API REST do bitERP para sistemas externos, automações e parceiros.
  - [Autenticação](/docs/api/authentication): Como autenticar na API de Integrações do bitERP usando API Keys ou OAuth2.
  - [Permissões](/docs/api/permissions): Como funciona o sistema de permissões granulares da API de Integrações.
  - [Paginação e Filtros](/docs/api/pagination): Como paginar resultados e filtrar dados na API de Integrações usando cursor pagination e flat query params.
  - [Códigos de Erro](/docs/api/errors): Referência de códigos de erro HTTP e formato de respostas de erro da API de Integrações.
  - [Versionamento da API](/docs/api/versioning): Como funciona o versionamento da API de Integrações via header api-version.
  - **Guias por recurso**

  - Guias: undefined
    - **Cadastros**

    - [Produtos](/docs/api/guides/products): Como cadastrar, buscar e manter produtos (bens e serviços) na API de Integrações, incluindo dados fiscais por país.
    - [Clientes](/docs/api/guides/customers): Como cadastrar e manter clientes na API de Integrações, incluindo tax_id (CPF/CNPJ ou EIN/SSN), endereço e dados por país.
    - [Fornecedores](/docs/api/guides/suppliers): Como cadastrar e manter fornecedores na API de Integrações — o cadastro espelho de clientes, base do fluxo de compras.
    - **Financeiro**

    - [Contas financeiras](/docs/api/guides/financial-accounts): O que é uma conta financeira, como criá-la e como calcular o saldo na API de Integrações.
    - [Transações e extrato](/docs/api/guides/financial-transactions): O ledger financeiro do bitERP — como consultar transações, o extrato por conta e o saldo, e remover lançamentos. Na API de Integrações você não cria nem edita transações: apenas consulta e exclui (soft delete).
    - [Contas a receber](/docs/api/guides/receivables): Ciclo de vida das contas a receber — criar, receber via alocação de transação, parcelar, cancelar — e os endpoints de vencidas e resumo.
    - [Contas a pagar](/docs/api/guides/payables): Ciclo de vida das contas a pagar — o espelho de contas a receber, com pagamento por alocação de transação de débito, parcelas, vencidas e resumo.
    - **Vendas e faturamento**

    - [Fluxo de vendas](/docs/api/guides/sales-flow): Visão geral do fluxo comercial no bitERP — do orçamento ao pedido, à nota e às contas a receber — e como os recursos se conectam.
    - [Orçamentos](/docs/api/guides/quotes): Como criar e manter orçamentos (quotes) com itens na API de Integrações, e sua relação com pedidos de venda.
    - [Pedidos de venda](/docs/api/guides/sales-orders): Como criar pedidos de venda na API de Integrações, vinculá-los a orçamentos e gerar contas a receber.
    - [Notas / faturas](/docs/api/guides/invoices): Como criar notas (invoices) na API de Integrações, vinculá-las a pedidos, gerar contas a receber e registrar impostos.
    - **Compras**

    - [Notas de compra](/docs/api/guides/purchase-invoices): Como registrar notas de compra na API de Integrações, vinculá-las a fornecedores e gerar contas a pagar.
    - **Dados de referência**

    - [Dados de referência](/docs/api/guides/reference-data): Os catálogos read-only da API — bancos, formas de pagamento, unidades de medida, países, estados e cidades — e como usá-los nos cadastros.
    - **Integração**

    - [Mapeamento de entidades](/docs/api/guides/integration-entity-mappings): Como vincular IDs de um sistema externo aos IDs internos do bitERP para garantir idempotência e evitar duplicações na sincronização.
  - **Referência**

  - Reference: undefined
    - Banks: undefined
      - [List banks available for the authenticated tenant's country](/docs/api/reference/banks/find-all)
      - [Get bank by national code (for tenant country)](/docs/api/reference/banks/find-by-code)
      - [Get bank by ID](/docs/api/reference/banks/find-by-id)
      - [Get bank by SWIFT/BIC code](/docs/api/reference/banks/find-by-swift-code)
    - Cities: undefined
      - [Get city by ID](/docs/api/reference/cities/find-by-id)
      - [List cities by state ID](/docs/api/reference/cities/find-by-state)
      - [Search cities by name within a state](/docs/api/reference/cities/search)
    - Countries: undefined
      - [List all active countries](/docs/api/reference/countries/find-all)
      - [Get country by ID](/docs/api/reference/countries/find-by-id)
      - [Get country by ISO2 code](/docs/api/reference/countries/find-by-iso2)
      - [Get country by ISO3 code](/docs/api/reference/countries/find-by-iso3)
    - Customers: undefined
      - [Contar clientes](/docs/api/reference/customers/count)
      - [Criar cliente](/docs/api/reference/customers/create)
      - [Remover cliente](/docs/api/reference/customers/delete)
      - [Listar clientes](/docs/api/reference/customers/find-all)
      - [Buscar cliente por ID](/docs/api/reference/customers/find-by-id)
      - [Buscar cliente por tax_id](/docs/api/reference/customers/find-by-tax-id)
      - [Buscar clientes por texto](/docs/api/reference/customers/search)
      - [Atualizar cliente](/docs/api/reference/customers/update)
    - Financial accounts: undefined
      - [Criar conta financeira](/docs/api/reference/financial-accounts/create)
      - [Remover conta financeira](/docs/api/reference/financial-accounts/delete)
      - [Listar contas financeiras](/docs/api/reference/financial-accounts/find-all)
      - [Buscar conta financeira por ID](/docs/api/reference/financial-accounts/find-by-id)
      - [Calcular saldo da conta financeira](/docs/api/reference/financial-accounts/get-balance)
      - [Atualizar conta financeira](/docs/api/reference/financial-accounts/update)
    - Financial categories: undefined
      - [Criar categoria financeira](/docs/api/reference/financial-categories/create)
      - [Remover categoria financeira](/docs/api/reference/financial-categories/delete)
      - [Listar categorias financeiras](/docs/api/reference/financial-categories/find-all)
      - [Buscar categoria financeira por ID](/docs/api/reference/financial-categories/find-by-id)
      - [Listar arvore de categorias financeiras](/docs/api/reference/financial-categories/find-tree)
      - [Atualizar categoria financeira](/docs/api/reference/financial-categories/update)
    - Financial transactions: undefined
      - [Remover transacao financeira](/docs/api/reference/financial-transactions/delete)
      - [Listar transacoes financeiras](/docs/api/reference/financial-transactions/find-all)
      - [Listar transacoes de uma conta (extrato)](/docs/api/reference/financial-transactions/find-by-account)
      - [Buscar transacao financeira por ID](/docs/api/reference/financial-transactions/find-by-id)
      - [Calcular saldo da conta financeira](/docs/api/reference/financial-transactions/get-balance)
    - Health: undefined
      - [Health check da API integrations](/docs/api/reference/health/get-health)
    - Integration entity mappings: undefined
      - [Criar mapeamento manual](/docs/api/reference/integration-entity-mappings/create)
      - [Remover mapeamento (soft delete)](/docs/api/reference/integration-entity-mappings/delete)
      - [Listar mapeamentos de entidade da integracao](/docs/api/reference/integration-entity-mappings/find-all)
      - [Buscar mapeamento por ID](/docs/api/reference/integration-entity-mappings/find-by-id)
      - [Atualizar mapeamento](/docs/api/reference/integration-entity-mappings/update)
    - Invoices: undefined
      - [Create invoice](/docs/api/reference/invoices/create)
      - [Delete invoice](/docs/api/reference/invoices/delete)
      - [List invoices](/docs/api/reference/invoices/find-all)
      - [Get invoice by ID](/docs/api/reference/invoices/find-by-id)
      - [Update invoice](/docs/api/reference/invoices/update)
    - Oauth: undefined
      - [OAuth token endpoint](/docs/api/reference/oauth/token)
    - Payables: undefined
      - [Alocar transacao em conta a pagar](/docs/api/reference/payables/allocate-transaction)
      - [Cancelar conta a pagar](/docs/api/reference/payables/cancel)
      - [Criar parcelas de contas a pagar](/docs/api/reference/payables/create-installments)
      - [Criar conta a pagar](/docs/api/reference/payables/create)
      - [Remover conta a pagar](/docs/api/reference/payables/delete)
      - [Listar contas a pagar](/docs/api/reference/payables/find-all)
      - [Buscar conta a pagar por ID](/docs/api/reference/payables/find-by-id)
      - [Listar contas a pagar vencidas](/docs/api/reference/payables/find-overdue)
      - [Resumo agregado por status](/docs/api/reference/payables/get-summary)
      - [Remover alocacao da conta a pagar](/docs/api/reference/payables/remove-allocation)
      - [Atualizar conta a pagar](/docs/api/reference/payables/update)
    - Payment methods: undefined
      - [List payment methods available for tenant country](/docs/api/reference/payment-methods/find-all)
      - [Get payment method by code](/docs/api/reference/payment-methods/find-by-code)
      - [Get payment method by ID](/docs/api/reference/payment-methods/find-by-id)
    - Products: undefined
      - [Criar produto](/docs/api/reference/products/create): Unidade de medida: use `unit_of_measurement_id` (UUID) no topo do payload. Para compatibilidade, `br_data.unit_of_measure` (depreciado) ainda aceita o mesmo UUID ou um código de unidade (ex.: UN, CX) resolvido pelo país do tenant. Se ambos forem enviados, devem referir-se à mesma unidade; em conflito, a API retorna erro de validação. Veja os exemplos do corpo da requisição.
      - [Remover produto](/docs/api/reference/products/delete)
      - [Listar produtos](/docs/api/reference/products/find-all)
      - [Buscar produto por ID](/docs/api/reference/products/find-by-id)
      - [Buscar produto por reference_code](/docs/api/reference/products/find-by-reference-code)
      - [Buscar produtos por texto](/docs/api/reference/products/search)
      - [Atualizar produto](/docs/api/reference/products/update): Mesmas regras de unidade que no POST: prefira `unit_of_measurement_id`; `br_data.unit_of_measure` permanece aceito (depreciado) e deve coincidir com o UUID quando ambos forem enviados.
    - Purchase invoices: undefined
      - [Create purchase invoice](/docs/api/reference/purchase-invoices/create)
      - [Delete purchase invoice](/docs/api/reference/purchase-invoices/delete)
      - [List purchase invoices](/docs/api/reference/purchase-invoices/find-all)
      - [Get purchase invoice by ID](/docs/api/reference/purchase-invoices/find-by-id)
      - [Update purchase invoice](/docs/api/reference/purchase-invoices/update)
    - Quotes: undefined
      - [Create quote](/docs/api/reference/quotes/create)
      - [Delete quote](/docs/api/reference/quotes/delete)
      - [List quotes](/docs/api/reference/quotes/find-all)
      - [Get quote by ID](/docs/api/reference/quotes/find-by-id)
      - [Update quote](/docs/api/reference/quotes/update)
    - Receivables: undefined
      - [Alocar transacao em conta a receber](/docs/api/reference/receivables/allocate-transaction)
      - [Cancelar conta a receber](/docs/api/reference/receivables/cancel)
      - [Criar parcelas de contas a receber](/docs/api/reference/receivables/create-installments)
      - [Criar conta a receber](/docs/api/reference/receivables/create)
      - [Remover conta a receber](/docs/api/reference/receivables/delete)
      - [Listar contas a receber](/docs/api/reference/receivables/find-all)
      - [Buscar conta a receber por ID](/docs/api/reference/receivables/find-by-id)
      - [Listar contas a receber vencidas](/docs/api/reference/receivables/find-overdue)
      - [Resumo agregado por status](/docs/api/reference/receivables/get-summary)
      - [Remover alocacao da conta a receber](/docs/api/reference/receivables/remove-allocation)
      - [Atualizar conta a receber](/docs/api/reference/receivables/update)
    - Sales orders: undefined
      - [Create sales order](/docs/api/reference/sales-orders/create)
      - [Delete sales order](/docs/api/reference/sales-orders/delete)
      - [List sales orders](/docs/api/reference/sales-orders/find-all)
      - [Get sales order by ID](/docs/api/reference/sales-orders/find-by-id)
      - [Update sales order](/docs/api/reference/sales-orders/update)
    - States: undefined
      - [Get state by code](/docs/api/reference/states/find-by-code)
      - [List states by country filter](/docs/api/reference/states/find-by-country)
      - [Get state by ID](/docs/api/reference/states/find-by-id)
      - [Search states by name and country filter](/docs/api/reference/states/search)
    - Suppliers: undefined
      - [Contar fornecedores](/docs/api/reference/suppliers/count)
      - [Criar fornecedor](/docs/api/reference/suppliers/create)
      - [Remover fornecedor](/docs/api/reference/suppliers/delete)
      - [Listar fornecedores](/docs/api/reference/suppliers/find-all)
      - [Buscar fornecedor por ID](/docs/api/reference/suppliers/find-by-id)
      - [Buscar fornecedor por tax_id](/docs/api/reference/suppliers/find-by-tax-id)
      - [Buscar fornecedores por texto](/docs/api/reference/suppliers/search)
      - [Atualizar fornecedor](/docs/api/reference/suppliers/update)
    - Tenant: undefined
      - [Obter tenant atual](/docs/api/reference/tenant/get-current-tenant)
    - Units of measurement: undefined
      - [List units of measurement available for tenant country](/docs/api/reference/units-of-measurement/find-all)
      - [Get unit of measurement by code](/docs/api/reference/units-of-measurement/find-by-code)
      - [Get unit of measurement by ID](/docs/api/reference/units-of-measurement/find-by-id)
- MCP Server: undefined
  - [MCP Server](/docs/mcp): Visão geral do servidor Model Context Protocol do bitERP para agentes de IA.
  - [Autenticação MCP](/docs/mcp/authentication): Como funciona a autenticação OAuth 2.0 via Clerk no MCP Server do bitERP.
  - [Tools Disponíveis](/docs/mcp/tools): Lista completa de ferramentas MCP disponíveis no bitERP com parâmetros e exemplos.
  - [Sessões](/docs/mcp/sessions): Como funciona o gerenciamento de sessões no MCP Server do bitERP.
  - [Tratamento de Erros](/docs/mcp/errors): Como o MCP Server do bitERP reporta erros para agentes de IA.