Version: 1.0
XDPeople Soba Invoice API v1
API para gestão completa do ciclo de vida de documentos de venda incluindo orçamentos, encomendas, faturas proforma, faturas de venda, recibos e notas de crédito.
Visão Geral
A Invoice API é um microserviço do XDPeople.Soba responsável pela gestão completa do ciclo de vida de documentos de venda, incluindo:
- 📝 Orçamentos (Quotes) - Propostas comerciais
- 📦 Encomendas (Orders) - Pedidos de clientes com reserva de stock opcional
- 📄 Faturas Proforma - Documentos de faturação antecipada
- 🧾 Faturas de Venda (Sales Invoices) - Documentos fiscais oficiais
- 💰 Recibos (Receipts) - Comprovantes de pagamento
- ↩️ Notas de Crédito (Credit Notes) - Devoluções e correções
Características Principais
- ✅ Criação, atualização e consulta de documentos
- ✅ Filtros avançados (status, datas, cliente, tipo de documento)
- ✅ Paginação de resultados
- ✅ Autenticação JWT
- ✅ Suporte multi-tenancy
- ✅ Arquitetura Clean Architecture com padrão CQRS
- ✅ Documentação Swagger/OpenAPI
Links Rápidos
- Guia de Utilização - Guia completo de utilização da API
- Índice de Guias - Guias especializados por tipo de documento
- Guia de Orçamentos - Criar propostas comerciais
- Guia de Encomendas - Processar pedidos de clientes
- Guia de Faturas - Emitir faturas de venda
- Guia de Recibos - Registar pagamentos
- Guia de Notas de Crédito - Gerir devoluções
Authentication
- HTTP: Bearer Auth
JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token in the text input below.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |