> For the complete documentation index, see [llms.txt](https://apidocs.cloudinvoice.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.cloudinvoice.net/documentacao-api/documentos/create.md).

# Create

Cria um novo documento.

## Criar Documento

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

#### Request Body

<table data-search="false"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>document_id</td><td>integer</td><td><p>Tipo de Documento</p><p></p><p>Consulte a tabela <a href="/documentacao-api/tipos-de-documentos/list.md">Tipos de Documentos</a>.</p></td></tr><tr><td>document_nature_id</td><td>integer</td><td><p>Natureza do Documento</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> obrigatório se  o campo <code>document_id</code> não for fornecido.</p><p></p><p>Consulte a tabela <a href="/documentacao-api/apendice.md#naturezas-de-documentos-campo-document_nature">Apêndice</a>.</p></td></tr><tr><td>document_nature_code</td><td>string</td><td><p>Código da Natureza do Documento</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Este parâmetro substitui <code>document_nature_id</code></p><p></p><p>Consulte a tabela <a href="/documentacao-api/apendice.md#naturezas-de-documentos-campo-document_nature">Apêndice</a> para saber mais.</p></td></tr><tr><td>document_serie_id</td><td>integer</td><td><p>Série de Documentos</p><p></p><p>Consulte a tabela <a href="/documentacao-api/series-de-documentos/list.md">Séries</a>.</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Apenas surtirá efeito quando submetido em simultâneo com o campo <code>document_id</code>.</p></td></tr><tr><td>document_date</td><td>date<br><sub><mark style="color:$info;">Format: yyyy-mm-dd</mark></sub></td><td>Data de Emissão<br><br><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Documentos de relevância fiscal (assinados) poderão ignorar este valor.</td></tr><tr><td>document_time</td><td>time<br><sub><mark style="color:$info;">Format: hh:mm:ss</mark></sub></td><td>Hora de Emissão<br><br><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Documentos de relevância fiscal (assinados) poderão ignorar este valor.</td></tr><tr><td>is_tax_included</td><td>boolean</td><td><p>Definir valores c/IVA Incluído.</p><p>Caso não defina, será usado de acordo com a configuração do documento.</p></td></tr><tr><td>party_class</td><td>integer</td><td><p>Classe de Entidade<br></p><p>Apenas em casos muito especííficos poderá ser necessário fornecer este valor. Por norma, este é deduzido da natureza do Documento usado.</p><p><br>Consulte a tabela <a href="/documentacao-api/apendice.md#classes-de-entidades-campo-party_class">Apêndice</a>.</p></td></tr><tr><td>party_id</td><td>integer</td><td><p>Entidade</p><p></p><p>Consulte a tabela <a href="/documentacao-api/clientes/list.md">Clientes</a>.</p></td></tr><tr><td>party_fiscal_number</td><td>string</td><td>NIF da Entidade</td></tr><tr><td>warehouse_id</td><td>integer</td><td>Armazém<br><br>Consulte Tabela Armazéns no Backoffice.</td></tr><tr><td>price_line_id</td><td>integer</td><td><p>Linha de Preços</p><p></p><p>Consulte a tabela <a href="/documentacao-api/linhas-de-precos/list.md#lista-de-linhas-de-precos">Linhas de Preços</a>.</p></td></tr><tr><td>our_reference</td><td>string</td><td>Nossa Referência.</td></tr><tr><td>document_reference</td><td>string</td><td><p>Referência do Documento</p><p></p><p>Este campo poderá ser de preenchimento obrigatório (ex: doc. de compra).</p></td></tr><tr><td>salesman_id</td><td>integer</td><td><p>Vendedor</p><p></p><p>Consulte a tabela de <a href="/documentacao-api/vendedores/list.md">Vendedores</a>.</p></td></tr><tr><td>payment_term_id</td><td>integer</td><td><p>Condição de Pagamento</p><p></p><p>Consulte a tabela <a href="/documentacao-api/condicoes-de-pagamento/list.md#lista-de-condicoes-de-pagamento">Condições de Pagamento</a> para saber mais.</p></td></tr><tr><td>global_discount1</td><td>float</td><td><p>Desconto Global</p><p>Valores entre 0 e 100.</p></td></tr><tr><td>details</td><td>array</td><td><p>Linhas do Documento</p><p></p><p>Deverá conter uma lista de objetos, sendo que cada objeto poderá conter os parâmetros de uma linha conforme descritos no <a href="/documentacao-api/documentos/apendice.md#linha-do-documento">Apêndice</a></p></td></tr><tr><td>total_round_amount</td><td>float</td><td><p>Valor de Acerto</p><p></p><p>Poderá tomar valores no intervalo de -9.99 a 9.99.<br><br><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> Os acertos estão disponíveis apenas em Documentos de Compra</p></td></tr><tr><td>payments</td><td>array</td><td><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="/documentacao-api/documentos/apendice.md#pagamento-do-documento">Apêndice</a></p></td></tr><tr><td>finalize</td><td>boolean<br><sub><mark style="color:$info;">Default: false</mark></sub></td><td><p>Finalizar após criação</p><p></p><p>Se pretender finalizar de imediato um documento de pagamento imediato (ex: Factura-Recibo), deverá fornecer dados relativos ao(s) pagamento(s) no campo <code>payments</code>.</p></td></tr><tr><td>is_transport_document</td><td>boolean</td><td><p>Indica se  é Documento de Transporte</p><p></p><p>Consulte os parâmetros disponíveis para transporte no <a href="/documentacao-api/documentos/apendice.md#dados-para-transporte">Apêndice</a>.</p></td></tr><tr><td>force_communication</td><td>boolean</td><td><p>Força comunicação do documento à AT.</p><p>Caso não indique, o documento será comunicado em automático se assim for necessário.</p></td></tr><tr><td>generate_mb_reference</td><td>boolean</td><td><p>Gerar Referência Multibanco<br></p><p>Esta opção apenas será considerada caso esteja configurada para a sua empresa.</p></td></tr><tr><td>header_text</td><td>string</td><td>Informação no Cabeçalho do Documento</td></tr><tr><td>footer_text</td><td>string</td><td>Informação no Rodapé do Documento</td></tr><tr><td>print</td><td>boolean</td><td><p>Imprimir Documento após Criação</p><p></p><p>O ficheiro PDF do Documento é gerado ao finalizar.</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> O Documento deverá ser finalizado.</p><p></p><p>Consulte os parâmetros disponíveis para impressão no <a href="/documentacao-api/documentos/apendice.md#impressao-do-documento">Apêndice</a>.</p></td></tr><tr><td>email</td><td>boolean</td><td><p>Enviar por E-mail após Criação</p><p></p><p><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> O Documento deverá estar finalizado.</p><p></p><p>Consulte os parâmetros disponíveis para impressão no <a href="/documentacao-api/documentos/apendice.md#envio-por-e-mail-do-documento">Apêndice</a>.</p></td></tr></tbody></table>

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

```shell
curl -X POST https://api.cloudinvoice.net/documents/new/
    -d '{
        "document_nature_id": "302",
        "party_id": "1",
        "details": [
            {
                "code": "PROD1",
                "base_qty": 1
            },
            {
                "code": "PROD2",
                "base_qty": 2,
                "line_unit_value": 2.00
            }
        ],
        "payments": [
            {
                "payment_method_id": 1
            }
        ],
        "finalize": true
    }'
```

{% endtab %}

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

```json
{
    "id": 1,
    "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
}
```

{% endtab %}
{% endtabs %}

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