Introdução
Autenticação
Resposta e erros
SDKs e plugins
Países
Isenções IVA
Changelog
Vendas
Recibos
Clientes
Clientes - Contas em aberto
Artigos
Artigos - Stock
Artigos - Movimentos stock
Agenda - Marcações
Agenda - Indisponibilidades
Administração
Administração - Armazéns
Administração - Categorias
Administração - Colaboradores
Administração - Condições de pagamento
Administração - Formas de pagamento
Administração - Modos de expedição
Administração - Moedas
Administração - Preços
Administração - Séries
Administração - Taxas de IVA
Administração - Tipos de documento
Administração - Veículos
Administração - Unidades
Subscrição - Locais
Vendas - Sumário
—Permite calcular em tempo real os totais (total de iva, total geral, etc) que vão ser emitidos no documento.
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de Crédito, Nota de Débito, Factura Pró-forma, Orçamento, Encomenda, Consulta de Mesa, Guia de Transporte, Guia de Remessa, Guia de Consignação, Guia de Devolução, Guia de movimentação de activos próprios.
Desconto financeiro €
Desconto global %
Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.
Custo unitário da despesa de transporte
Taxa de IVA da despesa de transporte. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
Moeda utilizada. Pode ser enviado o ID, símbolo ou descritivo, exemplo: €, $, Euro, Dólar. No caso de não preenchimento será assumido a moeda pré-definida.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
Taxa de retenção na fonte
Lista de artigos que constam no documento.
ID ou referência do artigo
Descrição adicional a aparecer no documento
Preço unitário
Quantidade
Desconto percentual
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
Isenção de IVA a aplicar. Pode ser enviado o ID ou o código, exemplo: M08, etc. No caso de não preenchimento será assumido o valor M18 - Sem isenção.
Request POST /sales/summary
{
"document_type": ..
"final_discount_financial": ..
"final_discount_global": ..
"shipping_mode": ..
"shipping_value": ..
"shipping_vat": ..
"currency": ..
"currency_exchange": ..
"vat_type": ..
"irs_retention_tax": ..
"items":
[
{
"id": ..
"details": ..
"price": ..
"quantity": ..
"discount": ..
"vat": ..
"vat_exemption": ..
}
],
}Response 200
{
"status":true,
"data":
{
"gross_total": ..
"total_discount": ..
"net_total": ..
"total_base_vat": ..
"total_vat": ..
"total_shipping": ..
"grand_total": ..
"grand_total_with_currency_exchange": ..
"final_discount_financial": ..
"final_discount_global": ..
"final_discount_global_value": ..
"total_services": ..
"total_quantity": ..
"irs_retention_apply": ..
"irs_retention_base": ..
"irs_retention_total": ..
"irs_retention_tax": ..
"items":
[
{
"sale_id": ..
"item_id": ..
"item_details": ..
"price": ..
"quantity": ..
"discount": ..
"gross_total": ..
"net_total": ..
"total_base_vat": ..
"total_vat": ..
"total_discount": ..
"grand_total": ..
"vat_id": ..
"unit_id": ..
"vat_exemption_id": ..
}
],
"vats":
[
{
"sale_id": ..
"vat_id": ..
"vat_tax": ..
"total_base_vat": ..
"total_vat": ..
}
]
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.