Finalize
Finaliza documento com possibilidade de impressão ou envio de e-mail.
Finalizar Documento
Documentos assinados (ex: Facturas) após a finalização passam a ter valor legal. Após a finalização, esta não poderá ser revertida e o conteúdo do documento não poderá mais ser alterado.
A única ação passível de ser aplicada a documentos finalizados capaz de os afectar é a Anulação.
POST https://api.cloudinvoice.net/documents/:id/finalize/
Path Parameters
id
integer
ID do Documento
Request Body
payments
Array
Pagamentos do Documento
Deverá conter uma lista de objetos, sendo que cada objeto poderá conter os parâmetros de um pagamento conforme descritos no Apêndice.
boolean
Imprimir Documento após a Finalização
O ficheiro PDF do Documento é gerado ao finalizar. Consulte os parâmetros disponíveis para impressão no Apêndice.
boolean
Enviar por E-mail após a Finalização Consulte os parâmetros disponíveis para impressão no Apêndice.
generate_mb_reference
boolean
Gerar Referência de Multibanco
Esta opção apenas será considerada caso esteja configurada para a sua empresa.
force_communication
boolean
Força comunicação do documento à AT
Caso não indique, o documento será comunicado em automático se assim for necessário.
curl -X POST https://api.cloudinvoice.net/documents/1/finalize/{
"id": 7641,
"doc_key": "FSI A01/1",
"document_date": "2023-01-11",
"document_time": "13:32:36",
"document_number": 1,
"document_reference": "",
"our_reference": "",
"module_origin": 1,
"party_id": 1,
"party": {
"class": 1601,
"code": 1,
"name": "Consumidor Final",
"commercial_name": "",
"fiscal_number": "999999990",
"street1": "",
"street2": "",
"zip_code": "",
"zip_locale": ""
},
"line_details_count": 2,
"lines_total_quantity": 3.0,
"is_valued": true,
"is_tax_included": true,
"total_gross_amount": 5.23,
"global_discount1": 0.0,
"total_global_discount": 0.0,
"total_line_discount": 0.0,
"total_net_amount": 4.2520325203,
"total_taxes_amount": 0.9779674797,
"total_amount": 5.23,
"total_document_amount": 5.23,
"total_round_amount": 0.0,
"total_due_amount": 0.0,
"due_date": "2023-01-11",
"is_converted": false,
"header_text": "",
"footer_text": "",
"number_of_prints": 0,
"is_transport_document": false,
"obs": "",
"document_nature_id": 302,
"document_nature": {
"code": "FS",
"description": "Factura Simplificada"
},
"document_id": 2,
"document": {
"code": "FSI",
"document_name": "Factura Simplificada",
"ask_payment_onclose": true
},
"document_serie_id": 1,
"document_serie": {
"code": "A01",
"description": "Série A01"
},
"document_status_id": 1202,
"document_status": {
"code": "F",
"description": "Finalizado"
},
"at_report_status_id": 1181,
"at_report_status": {
"code": "I",
"description": "Isento"
},
"warehouse_id": 1,
"warehouse": {
"code": 1,
"description": "Armazém 1"
},
"salesman_id": 1,
"salesman": {
"code": 1,
"salesman_name": "Empregado 1"
},
"payment_term_id": 1,
"payment_term": {
"code": 1,
"description": "Pronto Pagamento"
},
"payment_method_id": 1,
"payment_method": {
"code": 1,
"description": "Dinheiro"
},
"origin_document_header_id": null,
"origin_document_header": null
}Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.
Last updated