Guias Especializados por Tipo de Documento
Estes guias explicam como criar cada natureza suportada pela API de Facturação.
- Vendas —
POST /gateway/invoice/invoices - Compras —
POST /gateway/invoice/purchases
📚 Guias Disponíveis
Documentos de venda
📝 Guia de Orçamentos — ORC
Propostas comerciais; o stock depende da configuração do tipo de documento.
📦 Guia de Encomendas — NE
Pedidos de clientes; conversão para faturas com referências de linha.
🧾 Guia de Faturas — FT, FS
Vendas definitivas e faturas simplificadas; pagamentos obrigatórios.
🧾 Guia de Faturas-Recibo — FR
Venda com pagamento no mesmo documento.
↩️ Guia de Notas de Crédito — NC
Devoluções e correcções com referências obrigatórias e emissionReason.
📋 Guia de Notas de Débito — ND
Encargos adicionais ligados a documentos de origem.
🚚 Guias de Transporte — GT, GR, GA, GC, GD
Documentos de transporte com campos específicos: local de carga/descarga, datas e transportador.
Documentos de compra
🛒 Guia de Compras — FTF, FSF, FRF, NEF, ORF, FFF, DIF, GRF, GTF, GAF, GCF
Documentos de compra a fornecedor via POST /gateway/invoice/purchases. Fornecedor obrigatório; apenas naturezas da Onda A.
📊 Comparação Rápida
| Natureza | Código | Pagamentos | Stock | Fiscal |
|---|---|---|---|---|
| Orçamento | ORC | ✅ | Da config. do tipo | ❌ |
| Fatura proforma | FPF | ✅ | Da config. do tipo | ❌ |
| Documento interno | DI | ✅ | Da config. do tipo | ❌ |
| Encomenda | NE | ✅ | Da config. do tipo | ❌ |
| Fatura | FT | ✅ | Conforme tipo de documento | ✅ |
| Fatura simplificada | FS | ✅ | Conforme tipo de documento | ✅ |
| Fatura-recibo | FR | ✅ | Conforme tipo de documento | ✅ |
| Nota de crédito | NC | ✅ | Conforme tipo de documento | ✅ |
| Nota de débito | ND | ✅ | Conforme tipo de documento | ✅ |
| Guias transporte | GT…GD | Opcional | Conforme tipo de documento | ✅ |
| Factura de compra | FTF | ✅ / opcional* | Conforme tipo de documento | ✅ |
| Factura simplificada de compra | FSF | ✅ / opcional* | Conforme tipo de documento | ✅ |
| Factura-recibo de compra | FRF | ✅ / opcional* | Conforme tipo de documento | ✅ |
| Encomenda / orçamento / guias de compra | NEF, ORF, GRF… | Opcional* | Conforme tipo de documento | ✅ |
*A obrigatoriedade de pagamento nas compras segue os fluxos de caixa / conta-corrente do tipo de documento — ver o Guia de Compras.
O stock nunca se define nas linhas do pedido — segue a configuração do tipo de documento e do artigo.
O carácter obrigatório dos pagamentos depende da configuração do tipo de documento. Qualquer tipo com CashierFlow e CheckingAccountFlow a zero permite pagamentos opcionais; GT…GD, NE, ORC, FPF e DI são tipicamente configurados desta forma.
IDs de tipo de documento
Obtenha o documentTypeId via Guia de Utilização — IDs.
📅 Guia de TaxPointDate
Data do facto gerador (exigibilidade do IVA) e data de movimento de stock por linha — comportamento por defeito, datas retroactivas, compostos e conversões de documentos.
⚠️ Referência de Erros
Referência completa de todos os códigos de erro de validação e em runtime devolvidos pela API de Facturação, agrupados por categoria com condições e resoluções.
🎯 Por Onde Começar?
- Guia de Utilização — endpoints, modelo de dados, naturezas suportadas
- Guia de Faturas — fluxo de venda típico
- Guia de Compras — compras a fornecedor
- Guia de Notas de Crédito — devoluções
- Referência de Erros — códigos de erro e resoluções
🔗 Recursos Relacionados
- Referência da API — OpenAPI
- Guia de Utilização — referência geral
Última actualização: 25 de junho de 2026