Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 172 additions & 0 deletions docs/INDEX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
# Índice da Documentação

Navegue facilmente por toda a documentação do Asaas SDK.

## 🚀 Começando

| Documento | Descrição |
|-----------|-----------|
| [README Principal](README.md) | Visão geral completa do SDK |
| [Guia de Início Rápido](quickstart.md) | Comece em minutos |
| [Configurações Extras](extra.md) | Sandbox, timeout, rate limit |

## 💰 Pagamentos e Cobranças

| Documento | Descrição |
|-----------|-----------|
| [Cobranças](payment.md) | Criar, listar, estornar cobranças (PIX, Boleto, Cartão) |
| [Cobranças com Split](payment_split.md) | Dividir pagamentos entre múltiplas contas |
| [Links de Pagamento](paymentlink.md) | Criar páginas de checkout personalizadas |
| [Assinaturas](subscription.md) | Pagamentos recorrentes automáticos |
| [Parcelamentos](installment.md) | Gerenciar cobranças parceladas |

## 🔷 PIX

| Documento | Descrição |
|-----------|-----------|
| [PIX - QR Code e Chaves](pix_dict.md) | Criar QR codes, gerenciar chaves PIX |
| [PIX - Transações](pix_transaction.md) | Enviar e receber pagamentos PIX |
| [PIX Automático](pix_automatic.md) | Débito recorrente via PIX |

## 💸 Transferências

| Documento | Descrição |
|-----------|-----------|
| [Transferências](transfer.md) | TED, PIX e transferências internas |
| [Pagar Contas](bill.md) | Pagamento de boletos de terceiros |

## 👥 Gestão de Clientes

| Documento | Descrição |
|-----------|-----------|
| [Clientes](customeraccount.md) | CRUD completo de clientes |
| [Notificações](notification.md) | Gerenciar notificações de clientes |

## 🏢 Gestão de Conta

| Documento | Descrição |
|-----------|-----------|
| [Subcontas](account.md) | Criar e gerenciar subcontas |
| [Saldo](balance.md) | Consultar saldo disponível |
| [Extrato](financial.md) | Visualizar transações financeiras |
| [Dados Comerciais](commercialinfo.md) | Atualizar informações da empresa |
| [Status da Conta](myaccount.md) | Verificar situação da conta |
| [Taxas](accountfee.md) | Consultar taxas aplicadas |
| [Número de Conta](accountnumber.md) | Obter dados bancários |

## 🔔 Notificações e Integrações

| Documento | Descrição |
|-----------|-----------|
| [Webhooks](webhook.md) | Configurar notificações automáticas via HTTP |
| [Notas Fiscais](invoice.md) | Emitir e gerenciar NF-e |

## ⚙️ Configurações e Limites

| Documento | Descrição |
|-----------|-----------|
| [Configurações Extras](extra.md) | Sandbox, timeout e outras configurações |
| [Rate Limit](ratelimit.md) | Entender limites de requisição |

## 📊 Por Categoria

### Para Iniciantes
1. [Guia de Início Rápido](quickstart.md)
2. [Clientes](customeraccount.md)
3. [Cobranças](payment.md)
4. [Webhooks](webhook.md)

### Pagamentos
1. [Cobranças](payment.md)
2. [PIX - Transações](pix_transaction.md)
3. [Links de Pagamento](paymentlink.md)
4. [Assinaturas](subscription.md)

### PIX Completo
1. [PIX - QR Code e Chaves](pix_dict.md)
2. [PIX - Transações](pix_transaction.md)
3. [PIX Automático](pix_automatic.md)

### Gestão Financeira
1. [Saldo](balance.md)
2. [Extrato](financial.md)
3. [Transferências](transfer.md)
4. [Taxas](accountfee.md)

### Avançado
1. [Cobranças com Split](payment_split.md)
2. [PIX Automático](pix_automatic.md)
3. [Subcontas](account.md)
4. [Notas Fiscais](invoice.md)

## 🔍 Busca Rápida

### Quero criar...
- **Uma cobrança PIX** → [Cobranças](payment.md)
- **Um QR Code PIX** → [PIX - QR Code e Chaves](pix_dict.md)
- **Uma assinatura mensal** → [Assinaturas](subscription.md)
- **Um link de pagamento** → [Links de Pagamento](paymentlink.md)
- **Um cliente** → [Clientes](customeraccount.md)
- **Um webhook** → [Webhooks](webhook.md)

### Quero enviar...
- **Um PIX** → [PIX - Transações](pix_transaction.md)
- **Uma transferência TED** → [Transferências](transfer.md)
- **Dinheiro entre minhas contas** → [Transferências](transfer.md)

### Quero consultar...
- **Meu saldo** → [Saldo](balance.md)
- **Meu extrato** → [Extrato](financial.md)
- **Minhas taxas** → [Taxas](accountfee.md)
- **Status da minha conta** → [Status da Conta](myaccount.md)

### Quero gerenciar...
- **Chaves PIX** → [PIX - QR Code e Chaves](pix_dict.md)
- **Clientes** → [Clientes](customeraccount.md)
- **Subcontas** → [Subcontas](account.md)
- **Notificações** → [Notificações](notification.md)

## 📱 Recursos por Tipo de Negócio

### E-commerce
- [Cobranças](payment.md) - Receber pagamentos
- [Links de Pagamento](paymentlink.md) - Checkout personalizado
- [Webhooks](webhook.md) - Notificações automáticas
- [Cobranças com Split](payment_split.md) - Marketplace

### SaaS
- [Assinaturas](subscription.md) - Pagamentos recorrentes
- [Clientes](customeraccount.md) - Gestão de usuários
- [Webhooks](webhook.md) - Integração com sistema
- [Notas Fiscais](invoice.md) - Emissão automática

### Marketplace
- [Cobranças com Split](payment_split.md) - Dividir pagamentos
- [Subcontas](account.md) - Conta para cada vendedor
- [Transferências](transfer.md) - Repasses automáticos
- [Webhooks](webhook.md) - Notificações em tempo real

### Serviços Financeiros
- [PIX - Transações](pix_transaction.md) - Enviar e receber PIX
- [Transferências](transfer.md) - TED e transferências
- [Saldo](balance.md) - Consultar saldo
- [Extrato](financial.md) - Movimentações

## 🆘 Precisa de Ajuda?

- 📖 [README Principal](README.md) - Visão geral
- 💻 [Exemplos de Código](https://github.com/jpdev01/asaasSdk/blob/master/src/main/java/io/github/jpdev/asaassdk/doc/Examples.java)
- 🌐 [Documentação Oficial Asaas](https://docs.asaas.com)
- 🐛 [Reportar Problemas](https://github.com/jpdev01/asaasSdk/issues)

## 📝 Convenções da Documentação

- ✅ Exemplos testados e funcionais
- 💡 Dicas e boas práticas destacadas
- ⚠️ Avisos importantes sobre limitações
- 📊 Tabelas de referência rápida
- 🔗 Links para documentação relacionada

---

**Dica**: Use `Ctrl+F` (ou `Cmd+F` no Mac) para buscar palavras-chave nesta página!
Loading