# Aira

## Docs

- [Autenticação](https://docs.useaira.com/api-reference/autenticacao.md): Autentique suas requisições à API da Aira usando uma chave de API no header X-API-KEY.
- [Activate contract](https://docs.useaira.com/api-reference/contracts/activate-contract.md): Activates a draft contract. The contract must already have at least one active plan instance.
- [Create contract](https://docs.useaira.com/api-reference/contracts/create-contract.md): Creates a new contract in draft status. Plan instances must be attached before the contract can be activated.
- [Create contract recurring discount](https://docs.useaira.com/api-reference/contracts/create-contract-recurring-discount.md): Creates a recurring discount schedule for a contract. The discount is applied to each billing cycle within the date window.
- [Deactivate contract recurring discount](https://docs.useaira.com/api-reference/contracts/deactivate-contract-recurring-discount.md): Deactivates a recurring discount schedule on a contract. Already-issued invoices are not changed.
- [List contract recurring discounts](https://docs.useaira.com/api-reference/contracts/list-contract-recurring-discounts.md): Lists the recurring discounts configured for a contract.
- [Create credit pool](https://docs.useaira.com/api-reference/credit-pools/create-credit-pool.md): Creates a new credit pool for a customer.
- [List customer credit pools](https://docs.useaira.com/api-reference/credit-pools/list-customer-credit-pools.md): This endpoint allows fetching the credit pools associated with a customer.
- [Update credit pool](https://docs.useaira.com/api-reference/credit-pools/update-credit-pool.md): Updates a credit pool for a customer.
- [Create customer](https://docs.useaira.com/api-reference/customers/create-customer.md): Creates a new customer. Handles individual customers, organizations and subsidiaries (filiais) via the `type` field — subsidiaries require `parentCustomerId` pointing to an organization. Optionally accepts a `paymentAccount` payload to create the associated legal entity and payment account in the sa…
- [Delete customer](https://docs.useaira.com/api-reference/customers/delete-customer.md): This endpoint allows deleting a customer by id.
- [Delete customer by external ID](https://docs.useaira.com/api-reference/customers/delete-customer-by-external-id.md): This endpoint allows deleting a customer by external ID.
- [Fetch customer](https://docs.useaira.com/api-reference/customers/fetch-customer.md): This endpoint allows fetching a customer by id.
- [Fetch customer by external ID](https://docs.useaira.com/api-reference/customers/fetch-customer-by-external-id.md): This endpoint allows fetching a customer by external ID.
- [List customer subsidiaries](https://docs.useaira.com/api-reference/customers/list-customer-subsidiaries.md): This endpoint allows fetching subsidiaries by parent customer id.
- [List customers](https://docs.useaira.com/api-reference/customers/list-customers.md): This endpoint allows fetching a list of customers.
- [Update customer](https://docs.useaira.com/api-reference/customers/update-customer.md): This endpoint allows updating a customer by id.
- [Update customer by external ID](https://docs.useaira.com/api-reference/customers/update-customer-by-external-id.md): This endpoint allows updating a customer by external ID.
- [Respostas de erro](https://docs.useaira.com/api-reference/error-responses.md): Entenda o formato de erros e os códigos de status HTTP retornados pela API da Aira.
- [Archive events](https://docs.useaira.com/api-reference/events/archive-events.md): Archives the latest version of each event identified by the supplied `idempotencyKeys` by inserting an archive tombstone (version = N+1, archived_at = now()). Event rows are not deleted; the tombstone marks each key as archived. Idempotent: non-existent keys and already-archived keys are silently sk…
- [Ingest events](https://docs.useaira.com/api-reference/events/ingest-events.md): Ingests a batch of events. Each event is identified by its `idempotencyKey`: if no event exists for the key, version 1 is created; re-sending the key with unchanged `properties` (including `properties.value`) is a no-op; re-sending with changed `properties` records a new version that supersedes the…
- [Overwrite event](https://docs.useaira.com/api-reference/events/overwrite-event.md): Records a new version of the event identified by `idempotencyKey`, fully replacing `properties` (including `properties.value`). Frozen fields (`eventName`, `customerExternalId`, `occurredAt`) must match the existing event or the request is rejected with `ImmutableFieldChange`. If no event exists for…
- [Referência da API](https://docs.useaira.com/api-reference/introduction.md): Use a API REST da Aira para integrar eventos de uso, gerenciar clientes, consultar faturas e automatizar seu fluxo de faturamento.
- [Cancel invoice](https://docs.useaira.com/api-reference/invoices/cancel-invoice.md): Cancels a one-off invoice. Only one-off invoices can be modified through the public API.
- [Create invoice](https://docs.useaira.com/api-reference/invoices/create-invoice.md): Creates a one-off invoice in `open` status. Provide exactly one of `customerId` or `externalCustomerId`. When `paymentAccountId` is omitted or null, one of the customer's payment accounts is used.
- [Create invoice discount](https://docs.useaira.com/api-reference/invoices/create-invoice-discount.md): Creates a manual discount on an invoice. The discount can target the whole invoice, a line item group, or a single line item (via targetIdempotencyKey).
- [Create invoice line item](https://docs.useaira.com/api-reference/invoices/create-invoice-line-item.md): Creates a line item on a one-off invoice, optionally with sub-line items. When sub-line items are provided, their amounts must sum to the line item amount.
- [Create invoice line item group](https://docs.useaira.com/api-reference/invoices/create-invoice-line-item-group.md): Creates a line item group on a one-off invoice. The group is created empty; group amounts are derived from child line items. Empty groups are allowed.
- [Delete invoice discount](https://docs.useaira.com/api-reference/invoices/delete-invoice-discount.md): Deletes a discount from an invoice.
- [Delete invoice line item](https://docs.useaira.com/api-reference/invoices/delete-invoice-line-item.md): Deletes a line item from a one-off invoice.
- [Delete invoice line item group](https://docs.useaira.com/api-reference/invoices/delete-invoice-line-item-group.md): Deletes a line item group from a one-off invoice. Deleting a group also deletes all line items (and their sub-items and adjustments) it contains.
- [Download invoice PDF](https://docs.useaira.com/api-reference/invoices/download-invoice-pdf.md): This endpoint allows downloading the invoice artifact PDF file.
- [Fetch invoice](https://docs.useaira.com/api-reference/invoices/fetch-invoice.md): This endpoint allows fetching an invoice by id.
- [Fetch invoice by provider ID](https://docs.useaira.com/api-reference/invoices/fetch-invoice-by-provider-id.md): This endpoint allows fetching an invoice by its provider ID (e.g. ERP processor id from invoice_sync).
- [List invoice discounts](https://docs.useaira.com/api-reference/invoices/list-invoice-discounts.md): Lists the discounts applied to an invoice, including system-generated ones (the "reason" field shows the origin).
- [List invoices](https://docs.useaira.com/api-reference/invoices/list-invoices.md): This endpoint allows fetching a list of invoice summaries.
- [Mark invoice as in review](https://docs.useaira.com/api-reference/invoices/mark-invoice-as-in-review.md): Marks a one-off invoice as in_review. Only one-off invoices can be modified through the public API.
- [Update invoice](https://docs.useaira.com/api-reference/invoices/update-invoice.md): Updates the invoice date and memo of a one-off invoice. Only one-off invoices can be modified through the public API.
- [Update invoice discount](https://docs.useaira.com/api-reference/invoices/update-invoice-discount.md): Updates a discount on an invoice. The discount origin (reason) is preserved and cannot be changed via the API.
- [Update invoice line item](https://docs.useaira.com/api-reference/invoices/update-invoice-line-item.md): Updates a line item on a one-off invoice. When subLineItems is provided, the existing sub-line items are replaced.
- [Update invoice line item group](https://docs.useaira.com/api-reference/invoices/update-invoice-line-item-group.md): Updates the name, start date, and end date of a line item group on a one-off invoice.
- [List customer payment accounts](https://docs.useaira.com/api-reference/payment-accounts/list-customer-payment-accounts.md): This endpoint allows fetching the payment accounts associated with a customer.
- [Create plan instance](https://docs.useaira.com/api-reference/plan-instances/create-plan-instance.md): Creates a plan instance on a contract using the plan's current active version settings.
- [Fetch plan instance](https://docs.useaira.com/api-reference/plan-instances/fetch-plan-instance.md): This endpoint allows fetching a plan instance by id.
- [Update plan instance](https://docs.useaira.com/api-reference/plan-instances/update-plan-instance.md): Overrides the pricing and metrics of a plan instance by creating a new plan instance version.
- [Fetch resource](https://docs.useaira.com/api-reference/resources/fetch-resource.md): This endpoint allows fetching a resource by id.
- [List resources](https://docs.useaira.com/api-reference/resources/list-resources.md): This endpoint allows fetching a list of resources.
- [Webhooks](https://docs.useaira.com/api-reference/webhooks.md): Receba notificações em tempo real sobre eventos do sistema via webhooks.
- [Criar clientes](https://docs.useaira.com/clientes/criar-clientes.md): Cadastre clientes na Aira para associá-los a contratos, eventos de uso e faturas.
- [Portal do cliente](https://docs.useaira.com/clientes/portal-do-cliente.md): Disponibilize um portal dedicado para seus clientes acessarem faturas, métricas de uso e informações de cobrança.
- [Tipos e hierarquias](https://docs.useaira.com/clientes/tipos-e-hierarquias.md): Organize clientes em estruturas hierárquicas para cenários como holdings, subsidiárias e organizações com múltiplas unidades.
- [Conceitos Fundamentais](https://docs.useaira.com/comece-aqui/conceitos.md): Entenda as entidades centrais da Aira e como elas se conectam para formar um sistema completo de faturamento baseado em uso.
- [Primeiros passos](https://docs.useaira.com/comece-aqui/primeiros-passos.md): Envie seu primeiro evento, configure um recurso e crie um plano. Em poucos minutos, você verá a Aira calculando cobranças automaticamente.
- [Aira](https://docs.useaira.com/comece-aqui/visao-geral.md): A Aira é a plataforma de faturamento baseada em uso para empresas de software no Brasil. Gerencie eventos de consumo, precificação flexível, faturas automáticas e documentos fiscais em um único lugar.
- [Ciclo de vida](https://docs.useaira.com/contratos/ciclo-de-vida.md): Entenda os status de um contrato na Aira e as transições possíveis entre eles.
- [Configuração de cobrança](https://docs.useaira.com/contratos/configuracao-de-cobranca.md): Configure ciclos de cobrança, períodos, âncoras e prorrata nos contratos da Aira.
- [Criar contratos](https://docs.useaira.com/contratos/criar-contratos.md): Contratos vinculam um ou mais planos a um cliente, definindo quando a cobrança começa, o ciclo de faturamento e as regras de reajuste.
- [Descontos recorrentes](https://docs.useaira.com/contratos/descontos-recorrentes.md): Configure descontos que se repetem a cada ciclo de um contrato, dentro de uma janela de datas.
- [Políticas de impostos](https://docs.useaira.com/contratos/politica-de-impostos.md): Configure regras de retenção de impostos aplicadas automaticamente às faturas de cada contrato.
- [Reajustes](https://docs.useaira.com/contratos/reajustes.md): Aplique reajustes automáticos por IGPM, IPCA ou índice customizado aos contratos da Aira.
- [Conceder e consumir créditos](https://docs.useaira.com/creditos/conceder-e-consumir.md): Adicione créditos ao saldo de clientes e acompanhe como são consumidos automaticamente nas faturas.
- [Visão geral](https://docs.useaira.com/creditos/visao-geral.md): Créditos são saldos pré-pagos que podem ser aplicados automaticamente a faturas, reduzindo o valor a pagar.
- [Enviar eventos](https://docs.useaira.com/eventos/enviar-eventos.md): Envie eventos de uso para a Aira via API, interface do Dashboard, planilhas ou integrações.
- [Propriedades e idempotência](https://docs.useaira.com/eventos/propriedades-e-idempotencia.md): Use propriedades adicionais para segmentar eventos e chaves de idempotência para prevenir duplicatas.
- [Visão geral](https://docs.useaira.com/eventos/visao-geral.md): Eventos são registros de uso gerados pelos seus clientes. Eles são a base de todo o faturamento baseado em uso na Aira.
- [Ciclo de vida da fatura](https://docs.useaira.com/faturas/ciclo-de-vida.md): Faturas passam por múltiplos status — de Aberta até Paga ou Atrasada — com ações disponíveis em cada etapa.
- [Criar faturas via API](https://docs.useaira.com/faturas/criar-via-api.md): Crie faturas avulsas programaticamente em etapas: cabeçalho, grupos, linhas de cobrança e submissão para revisão.
- [Descontos e alocações](https://docs.useaira.com/faturas/descontos-e-alocacoes.md): Aplique descontos monetários ou percentuais e distribua o valor da fatura entre múltiplos destinatários.
- [Documentos fiscais](https://docs.useaira.com/faturas/documentos-fiscais.md): A Aira sincroniza NFSe via ERP e gera PDFs e XMLs automaticamente como parte do fluxo de faturamento.
- [Faturamento de clientes](https://docs.useaira.com/faturas/faturamento-de-clientes.md): Entenda como a Aira gera faturas automaticamente a partir de ciclos de cobrança, com itens de linha detalhados e cálculos baseados no uso real.
- [Importação de faturas](https://docs.useaira.com/faturas/importacao.md): Importe faturas em lote a partir de uma planilha XLSX. Cada linha representa uma linha de cobrança; múltiplas linhas com a mesma chave de idempotência formam uma única fatura.
- [Asaas](https://docs.useaira.com/integracoes/asaas.md): Processe cobranças via PIX, Boleto e cartão de crédito com o Asaas.
- [Celcash](https://docs.useaira.com/integracoes/celcash.md): Processe cobranças via PIX, Boleto e Bolepix com rastreamento automático de pagamentos.
- [Conta Azul](https://docs.useaira.com/integracoes/conta-azul.md): Sincronize dados financeiros e contábeis com o Conta Azul.
- [HubSpot](https://docs.useaira.com/integracoes/hubspot.md): Crie contratos e registre expansões na Aira direto dos deals do HubSpot via webhooks.
- [NetSuite](https://docs.useaira.com/integracoes/netsuite.md): Sincronize faturas e dados contábeis com o Oracle NetSuite.
- [Omie](https://docs.useaira.com/integracoes/omie.md): Sincronize faturas, contratos, pagamentos e documentos fiscais com o ERP Omie.
- [Rubeus](https://docs.useaira.com/integracoes/rubeus.md): Sincronize clientes e oportunidades com a Rubeus.
- [Salesforce](https://docs.useaira.com/integracoes/salesforce.md): Sincronize clientes e oportunidades com o Salesforce CRM.
- [Senior](https://docs.useaira.com/integracoes/senior.md): Integre a Aira ao ERP Senior para sincronizar faturas e dados financeiros.
- [Stripe](https://docs.useaira.com/integracoes/stripe.md): Processe pagamentos internacionais e gerencie cobranças com o Stripe.
- [TOTVS](https://docs.useaira.com/integracoes/totvs.md): Integre a Aira ao ERP TOTVS para sincronizar faturas e dados financeiros.
- [Integrações](https://docs.useaira.com/integracoes/visao-geral.md): Conecte a Aira ao seu ERP, gateway de pagamento e CRM para automatizar o fluxo financeiro completo.
- [Métodos de pagamento](https://docs.useaira.com/pagamentos/metodos-de-pagamento.md): A Aira suporta cobrança via PIX, Boleto e Bolepix, integrados com gateways de pagamento brasileiros.
- [Rastreamento e conciliação](https://docs.useaira.com/pagamentos/rastreamento-e-conciliacao.md): Acompanhe o status de pagamentos, registre pagamentos manuais e concilie com o ERP.
- [Criar planos](https://docs.useaira.com/planos/criar-planos.md): Planos definem as regras de cobrança: mensalidade fixa, franquia mínima e métricas baseadas em uso com precificação flexível.
- [Modelos de precificação](https://docs.useaira.com/planos/modelos-de-precificacao.md): A Aira suporta precificação por unidade, pacote, valor fixo e percentual, com faixas progressivas ou faixa única.
- [Versionamento](https://docs.useaira.com/planos/versionamento.md): Planos são versionados por contrato. Cada contrato mantém sua própria versão do plano, garantindo zero efeitos colaterais.
- [Filtragem e agregação](https://docs.useaira.com/recursos/filtragem-e-agregacao.md): Configure filtros para selecionar eventos específicos e escolha como eles serão agregados dentro do ciclo de cobrança.
- [Tipos de recursos](https://docs.useaira.com/recursos/tipos-de-recursos.md): Recursos podem ser unitários (quantidades discretas) ou monetários (valores financeiros). O tipo afeta como são exibidos e quais modelos de precificação podem ser aplicados.
- [Visão geral](https://docs.useaira.com/recursos/visao-geral.md): Recursos transformam eventos brutos em métricas de cobrança, definindo quais eventos contam e como são agregados.
- [Dashboard](https://docs.useaira.com/relatorios/dashboard.md): Acompanhe métricas de faturamento, pagamentos e uso dos seus clientes em um painel centralizado.
- [Exportação de dados](https://docs.useaira.com/relatorios/exportacao-de-dados.md): Exporte dados de eventos, planos, faturas e relatórios customizados em CSV ou Excel.
- [Segurança](https://docs.useaira.com/seguranca/visao-geral.md): Como a Aira protege os dados financeiros dos seus clientes.

## OpenAPI Specs

- [openapi](https://docs.useaira.com/api-reference/openapi.yaml)

## Optional

- [Dashboard](https://app.useaira.com)
- [Fale com a equipe](mailto:contato@useaira.com)