# Finalize

## Finalizar Documento

{% hint style="warning" %}
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.
{% endhint %}

## Finaliza documento com possibilidade de impressão ou envio de e-mail.

<mark style="color:green;">`POST`</mark> `https://api.cloudinvoice.net/documents/:id/finalize/`

#### Path Parameters

| Name | Type    | Description     |
| ---- | ------- | --------------- |
| id   | integer | ID do Documento |

#### Request Body

| Name                    | Type    | Description                                                                                                                                                                                                                                          |
| ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| payments                | Array   | <p>Pagamentos do Documento</p><p></p><p>Deverá conter uma lista de objetos, sendo que cada objeto poderá conter os parâmetros de um pagamento conforme descritos no <a href="/pages/BdlvhGZBoKlBoSmsSOiC#pagamento-do-documento">Apêndice</a>.</p>   |
| print                   | boolean | <p>Imprimir Documento após a Finalização</p><p> </p><p>O ficheiro PDF do Documento é gerado ao finalizar.<br><br>Consulte os parâmetros disponíveis para impressão no <a href="/pages/BdlvhGZBoKlBoSmsSOiC#impressao-do-documento">Apêndice</a>.</p> |
| email                   | boolean | <p>Enviar por E-mail após a Finalização<br><br>Consulte os parâmetros disponíveis para impressão no <a href="/pages/BdlvhGZBoKlBoSmsSOiC#envio-por-e-mail-do-documento">Apêndice</a>.</p>                                                            |
| generate\_mb\_reference | boolean | <p>Gerar Referência de Multibanco</p><p></p><p>Esta opção apenas será considerada caso esteja configurada para a sua empresa.</p>                                                                                                                    |
| force\_communication    | boolean | <p>Força comunicação do documento à AT</p><p></p><p>Caso não indique, o documento será comunicado em automático se assim for necessário.</p>                                                                                                         |

{% tabs %}
{% tab title="Exemplo de Pedido" %}

```shell
curl -X POST https://api.cloudinvoice.net/documents/1/finalize/
```

{% endtab %}

{% tab title="Exemplo de Resposta" %}

<pre class="language-json"><code class="lang-json">{
    "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"
    },
<strong>    "document_status_id": 1202,
</strong><strong>    "document_status": {
</strong><strong>        "code": "F",
</strong><strong>        "description": "Finalizado"
</strong><strong>    },
</strong>    "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
}
</code></pre>

{% endtab %}
{% endtabs %}

Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](/introducao/exemplos-de-pedidos.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.cloudinvoice.net/documentacao-api/documentos/finalize.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.