> 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/apendice.md).

# Apêndice

## Linha do Documento

<table><thead><tr><th width="173.5">Parâmetros</th><th width="94">Tipo</th><th width="357">Descrição</th><th width="120" data-type="checkbox">Obrigatório</th></tr></thead><tbody><tr><td>code</td><td>string</td><td><p>Identificador do produto a usar na linha</p><p></p><p>Pode referir-se tanto ao 'código' como ao 'código de barras' de um produto, ou ainda a um 'código alternativo' por este usado.</p></td><td>true</td></tr><tr><td>description</td><td>string</td><td><p>Descrição</p><p></p><p>Este valor, se preenchido, vai sobrepor-se à descrição na ficha do produto apenas na presente linha.</p></td><td>false</td></tr><tr><td>long_description</td><td>string</td><td>Descrição Alargada<br><br><mark style="color:orange;">Nota:  A utilização deste campo pode estar limitada por opções de configuração do CloudInvoice.</mark><br><mark style="color:orange;">Tamanho: 10000</mark></td><td>false</td></tr><tr><td>base_qty</td><td>float</td><td><p>Quantidade </p><p>Default: 1</p></td><td>false</td></tr><tr><td>line_discount1</td><td>float</td><td>Desconto de Linha #1<br>Valores entre 0 e 100</td><td>false</td></tr><tr><td>line_discount2</td><td>float</td><td>Desconto de Linha #2<br>Valores entre 0 e 100</td><td>false</td></tr><tr><td>line_unit_value</td><td>float</td><td><p>Preço Unitário</p><p></p><p>O valor fornecido deverá ser o Preço Unitário sem IVA se o documento estiver definido como contendo valores sem IVA. Deverá já incluir IVA caso contrário.</p></td><td>false</td></tr><tr><td>vat_tax_id</td><td>integer</td><td><p>Taxa de IVA</p><p><br>Consulte a tabela <a href="/pages/MnQEzHg9hHBIujlC0gqe#lista-de-tabelas-de-impostos">Tabelas de Impostos</a>.<br><br><span data-gb-custom-inline data-tag="emoji" data-code="26a0">⚠️</span> A utilização deste campo está dependente da configuração <code>allow_tax_code_change_documents</code></p></td><td>false</td></tr></tbody></table>

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

```json
{
    "code": "PROD1",
    "description": "Produto 1",
    "base_qty": 1,
    "line_unit_value": 100,
    "line_discount1": 10,
    "line_discount2": 5
}
```

{% endtab %}
{% endtabs %}

## Linhas do Documento de Origem

Estes objectos são usados nas emissões/conversões de Documentos.\
Contêm a identificação da linha de origem, assim como alguns valores opcionais que possam ser alterados durante o processo.

<table><thead><tr><th width="173.5">Parâmetros</th><th width="94">Tipo</th><th width="357">Descrição</th><th width="120" data-type="checkbox">Obrigatório</th></tr></thead><tbody><tr><td>id</td><td>integer</td><td>Linha do Documento de origem</td><td>true</td></tr><tr><td>base_qty</td><td>float</td><td><p>Quantidade</p><p><br>Se não definida, tomará, na maior parte dos casos, o valor da Quantidade da linha de origem.</p></td><td>false</td></tr><tr><td>line_unit_value</td><td>float</td><td><p>Preço Unitário</p><p></p><p>Se não definido, tomará, na maior parte dos casos, o valor do Preço Unitário da linha de origem.</p></td><td>false</td></tr></tbody></table>

## Pagamento do Documento

<table><thead><tr><th width="256.5">Parâmetros</th><th width="94">Tipo</th><th width="227">Descrição</th><th width="120" data-type="checkbox">Obrigatório</th></tr></thead><tbody><tr><td>payment_method_id</td><td>integer</td><td><p>Método de Pagamento</p><p><br>Consulte a tabela <a href="/pages/H5o1QL6JH88fxFVknUUm#lista-de-metodos-de-pagamento">Métodos de Pagamento</a>.</p></td><td>true</td></tr><tr><td>amount_received_currency</td><td>float</td><td>Valor do Pagamento<br>Default: Valor em Dívida</td><td>false</td></tr><tr><td>payment_doc_reference</td><td>string</td><td><p>Referência do Pagamento</p><p></p><p>O preenchimento deste campo é obrigatório em alguns métodos de pagamento.</p></td><td>false</td></tr><tr><td>payment_doc_date</td><td>date</td><td><p>Data do Documento de Pagamento </p><p>(Ex: Data do Cheque bancário)</p></td><td>false</td></tr></tbody></table>

## Impressão do Documento

<table><thead><tr><th width="256.5">Parâmetros</th><th width="94">Tipo</th><th width="227">Descrição</th><th width="120" data-type="checkbox">Obrigatório</th></tr></thead><tbody><tr><td>print</td><td>boolean</td><td><p>Imprimir Documento</p><p></p><p>Apenas pode imprimir documentos finalizados/anulados.</p></td><td>true</td></tr><tr><td>format</td><td>string</td><td><p>Formato de Impressão:</p><p>Opções: [a4/a5/ticket].</p><p></p><p>Caso não indique, será usado o formato configurado no documento.</p></td><td>false</td></tr><tr><td>print_copies</td><td>number</td><td><p>Número de cópias.</p><p>Opções: [1-6] / 2via.</p><p></p><p>Caso não indique, será impresso o número de cópias configurado no documento.</p></td><td>false</td></tr><tr><td>print_copy</td><td>number</td><td><p>Indica o número da cópia a imprimir</p><p>Opções: [1-6] / 2via.</p><p></p><p>Caso pretenda imprimir apenas uma cópia específica (Ex: Imprimir apenas triplicado)</p></td><td>false</td></tr><tr><td>layout_id</td><td>integer</td><td><p>Layout de Impressão</p><p></p><p>Caso não indique, será usado o layout configurado no documento de acordo com o formato de impressão.</p></td><td>false</td></tr></tbody></table>

## Envio por E-mail do Documento

<table><thead><tr><th width="256.5">Parâmetros</th><th width="94">Tipo</th><th width="227">Descrição</th><th width="120" data-type="checkbox">Obrigatório</th></tr></thead><tbody><tr><td>email</td><td>boolean</td><td><p>Enviar por E-mail</p><p></p><p>Apenas pode imprimir documentos finalizados/anulados.</p></td><td>true</td></tr><tr><td>email_address</td><td>email</td><td>Endereço de Destino</td><td>true</td></tr><tr><td>email_subject</td><td>string</td><td>Assunto do E-mail</td><td>false</td></tr><tr><td>email_message</td><td>string</td><td>Mensagem do E-mail</td><td>false</td></tr><tr><td>email_cc</td><td>email</td><td>Endereço cc</td><td>false</td></tr><tr><td>email_bcc</td><td>email</td><td>Endereço bcc</td><td>false</td></tr></tbody></table>

## Dados para Transporte

<table><thead><tr><th width="236.5">Parâmetros</th><th width="106">Tipo</th><th width="255">Descrição</th><th width="120" data-type="checkbox">Obrigatório</th></tr></thead><tbody><tr><td>is_transport_document</td><td>boolean</td><td>É Doc. de Transporte</td><td>true</td></tr><tr><td>load_date</td><td>datetime</td><td>Data de Carga<br>Formato: <br>"YYYY-MM-DD hh:mm:ss"</td><td>false</td></tr><tr><td>load_shipment_id</td><td>integer</td><td><p>Local de Carga</p><p><br>Consulte Tabela Cargas e Descargas no Backoffice.</p></td><td>false</td></tr><tr><td>ship_from_warehouse_id</td><td>integer</td><td><p>Armazém de Origem</p><p><br>Consulte Tabela Armazéns no Backoffice.</p></td><td>false</td></tr><tr><td>ship_from_street1</td><td>string</td><td>Morada de Carga</td><td>false</td></tr><tr><td>ship_from_street2</td><td>string</td><td>Morada de Carga Linha 2</td><td>false</td></tr><tr><td>ship_from_zip_code</td><td>string</td><td>Código Postal (Origem)</td><td>false</td></tr><tr><td>ship_from_zip_locale</td><td>string</td><td>Localidade (Origem)</td><td>false</td></tr><tr><td>ship_from_city</td><td>email</td><td>Cidade (Origem)</td><td>false</td></tr><tr><td>vehicle_plate</td><td>string</td><td>Matrícula da Viatura</td><td>false</td></tr><tr><td>unload_date</td><td>datetime</td><td>Data de Descarga<br>Formato: <br>"YYYY-MM-DD hh:mm:ss"</td><td>false</td></tr><tr><td>unload_shipment_id</td><td>integer</td><td><p>Local de Descarga</p><p><br>Consulte Tabela Cargas e Descargas no Backoffice.</p></td><td>false</td></tr><tr><td>ship_to_street1</td><td>string</td><td>Morada de Descarga</td><td>false</td></tr><tr><td>ship_to_street2</td><td>string</td><td>Morada de Descarga Linha 2</td><td>false</td></tr><tr><td>ship_to_zip_code</td><td>string</td><td>Código Postal (Destino)</td><td>false</td></tr><tr><td>ship_to_zip_locale</td><td>string</td><td>Localidade (Destino)</td><td>false</td></tr><tr><td>ship_to_city</td><td>string</td><td>Cidade (Destino)</td><td>false</td></tr><tr><td>ship_to_country_id</td><td>integer</td><td><p>País de Destino</p><p><br>Consulte Tabela <a href="/pages/zDxRAoofNg5nAbyoGGBy#lista-de-paises">Países</a>.</p></td><td>false</td></tr></tbody></table>

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